DevExpress.XtraSpreadsheet.v17.2.xml 122 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>DevExpress.XtraSpreadsheet.v17.2</name>
  5. </assembly>
  6. <members>
  7. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventHandler">
  8. <summary>
  9. <para>A method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomCellEdit"/> event of the SpreadsheetControl.
  10. </para>
  11. </summary>
  12. </member>
  13. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventArgs)">
  14. <summary>
  15. <para>A method that will handle the <b>CustomCellEdit</b> event of the SpreadsheetControl.
  16. </para>
  17. </summary>
  18. <param name="sender">
  19. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  20. </param>
  21. <param name="e">
  22. A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventArgs"/> object which contains event data.
  23. </param>
  24. </member>
  25. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventArgs">
  26. <summary>
  27. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomCellEdit"/> event.
  28. </para>
  29. </summary>
  30. </member>
  31. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventArgs.#ctor(DevExpress.XtraSpreadsheet.Internal.InnerSpreadsheetControl,DevExpress.XtraSpreadsheet.Model.Worksheet,System.Int32,System.Int32,DevExpress.Spreadsheet.ValueObject,DevExpress.XtraEditors.Repository.RepositoryItem)">
  32. <summary>
  33. <para>Initializes a new instance of the SpreadsheetCustomCellEditEventArgs class with the specified settings.
  34. </para>
  35. </summary>
  36. <param name="innerControl">
  37. An <b>InnerSpreadsheetControl</b> object.
  38. </param>
  39. <param name="sheet">
  40. A worksheet that contains the cell for which the event has been raised.
  41. </param>
  42. <param name="columnIndex">
  43. An integer specifying the index of the column that contains the cell for which the event has been raised.
  44. </param>
  45. <param name="rowIndex">
  46. An integer specifying the index of the row that contains the cell for which the event has been raised.
  47. </param>
  48. <param name="valueObject">
  49. A <see cref="T:DevExpress.Spreadsheet.ValueObject"/> value associated with the custom in-place editor assigned to the processed cell.
  50. </param>
  51. <param name="repositoryItem">
  52. A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> descendant specifying the in-place editor assigned to the processed cell.
  53. </param>
  54. </member>
  55. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventArgs.RepositoryItem">
  56. <summary>
  57. <para>Gets or sets the in-place editor for the current cell.
  58. </para>
  59. </summary>
  60. <value>A <see cref="T:DevExpress.XtraEditors.Repository.RepositoryItem"/> descendant that specifies the in-place editor for the current cell.
  61. </value>
  62. </member>
  63. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetCustomCellEditEventArgs.ValueObject">
  64. <summary>
  65. <para>Gets a value associated with the <see cref="T:DevExpress.Spreadsheet.CustomCellInplaceEditor"/> object assigned to the cell.
  66. </para>
  67. </summary>
  68. <value>A <see cref="T:DevExpress.Spreadsheet.ValueObject"/> object associated with the custom cell editor.
  69. </value>
  70. </member>
  71. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions">
  72. <summary>
  73. <para>Contains options which affect the behavior of the Data Source Wizard.
  74. </para>
  75. </summary>
  76. </member>
  77. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.#ctor">
  78. <summary>
  79. <para>Initializes a new instance of the SpreadsheetDataSourceWizardOptions class with the default settings.
  80. </para>
  81. </summary>
  82. </member>
  83. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.AlwaysSaveCredentials">
  84. <summary>
  85. <para>Gets or sets whether the user will be prompted to save credentials after creating a connection string.
  86. </para>
  87. </summary>
  88. <value><b>True</b>, to save credentials in the connection string without prompting; otherwise, <b>false</b>.
  89. </value>
  90. </member>
  91. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.CustomAssemblyBehavior">
  92. <summary>
  93. <para>Enables you to specify whether the Data Source Wizard can load a custom assembly containing the Entity Framework data context during mail merge.
  94. </para>
  95. </summary>
  96. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetCustomAssemblyBehavior"/> enumeration value that specifies whether to load an assembly without prompting, to not load and disable browsing for the assembly file, or pass the request to a special service.
  97. </value>
  98. </member>
  99. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.DataSourceTypes">
  100. <summary>
  101. <para>Gets or sets data source types displayed on the &quot;Select the data source type&quot; page of the Data Source Wizard.
  102. </para>
  103. </summary>
  104. <value>A <see cref="T:DevExpress.Office.Options.DataSourceTypes"/> enumeration member.
  105. </value>
  106. </member>
  107. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.DisableNewConnections">
  108. <summary>
  109. <para>Gets or sets whether an option for the user to create a new connection by specifying connection parameters is shown.
  110. </para>
  111. </summary>
  112. <value><b>True</b>, to choose from existing connections only; otherwise, <b>false</b>.
  113. </value>
  114. </member>
  115. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.EnableCustomSql">
  116. <summary>
  117. <para>Gets or sets whether the direct SQL text editing is enabled.
  118. </para>
  119. </summary>
  120. <value><b>True</b>, to enable direct SQL text editing; otherwise, <b>false</b>.
  121. </value>
  122. </member>
  123. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.QueryBuilderLight">
  124. <summary>
  125. <para>Specifies whether or not the Query Builder enables end-users to specify custom SQL queries, column aliases and expressions.
  126. </para>
  127. </summary>
  128. <value><b>true</b>, to disallow end-users from specifying custom SQL queries, column aliases and expressions; otherwise, <b>false</b>.
  129. </value>
  130. </member>
  131. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions.ShowEFWizardBrowseButton">
  132. <summary>
  133. <para>Gets or sets a value indicating whether the <b>Browse...</b> button is displayed on the Data Source Wizard page, which allows an end-user to select the required Entity Framework data context.
  134. </para>
  135. </summary>
  136. <value><b>true</b>, to show the <b>Browse...</b> button on the "Choose a data context" page; otherwise, <b>false</b>.
  137. </value>
  138. </member>
  139. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetElementVisibility">
  140. <summary>
  141. <para>Lists values used to specify the visibility of a certain element of the SpreadsheetControl.
  142. </para>
  143. </summary>
  144. </member>
  145. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetElementVisibility.Default">
  146. <summary>
  147. <para>The element of the SpreadsheetControl is hidden or displayed as specified by the workbook display options.
  148. </para>
  149. </summary>
  150. </member>
  151. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetElementVisibility.Hidden">
  152. <summary>
  153. <para>The element of the SpreadsheetControl is always hidden.
  154. </para>
  155. </summary>
  156. </member>
  157. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetElementVisibility.Visible">
  158. <summary>
  159. <para>The element of the SpreadsheetControl is always displayed.
  160. </para>
  161. </summary>
  162. </member>
  163. <member name="T:DevExpress.XtraSpreadsheet.FrozenPaneBorderType">
  164. <summary>
  165. <para>Lists values used to specify the frozen pane type.
  166. </para>
  167. </summary>
  168. </member>
  169. <member name="F:DevExpress.XtraSpreadsheet.FrozenPaneBorderType.Horizontal">
  170. <summary>
  171. <para>The horizontal frozen pane (frozen rows).
  172. </para>
  173. </summary>
  174. </member>
  175. <member name="F:DevExpress.XtraSpreadsheet.FrozenPaneBorderType.Vertical">
  176. <summary>
  177. <para>The vertical frozen pane (frozen columns).
  178. </para>
  179. </summary>
  180. </member>
  181. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventHandler">
  182. <summary>
  183. <para>A method that will handle the <b>CustomDrawFrozenPaneBorder</b> event of the SpreadsheetControl.
  184. </para>
  185. </summary>
  186. </member>
  187. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs)">
  188. <summary>
  189. <para>A method that will handle the <b>CustomDrawFrozenPaneBorder</b> event of the SpreadsheetControl.
  190. </para>
  191. </summary>
  192. <param name="sender">
  193. The event source. This parameter identifies the SpreadsheetControl that raised the event.
  194. </param>
  195. <param name="e">
  196. A <see cref="T:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs"/> object which contains event data.
  197. </param>
  198. </member>
  199. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs">
  200. <summary>
  201. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawFrozenPaneBorder"/> event.
  202. </para>
  203. </summary>
  204. </member>
  205. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs.ForeColor">
  206. <summary>
  207. <para>Gets the color of the frozen pane border line.
  208. </para>
  209. </summary>
  210. <value>A <see cref="T:System.Drawing.Color"/> structure that specifies the color of the frozen pane border line.
  211. </value>
  212. </member>
  213. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs.Point1">
  214. <summary>
  215. <para>Gets the first endpoint of the frozen pane border line.
  216. </para>
  217. </summary>
  218. <value>A <see cref="T:System.Drawing.Point"/> structure that specifies the point where the line drawing starts.
  219. </value>
  220. </member>
  221. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs.Point2">
  222. <summary>
  223. <para>Gets the second endpoint of the frozen pane border line.
  224. </para>
  225. </summary>
  226. <value>A <see cref="T:System.Drawing.Point"/> structure that specifies the point where the line drawing finishes.
  227. </value>
  228. </member>
  229. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs.Type">
  230. <summary>
  231. <para>Gets whether the frozen pane is vertical or horizontal.
  232. </para>
  233. </summary>
  234. <value>A <see cref="T:DevExpress.XtraSpreadsheet.FrozenPaneBorderType"/> enumeration member.
  235. </value>
  236. </member>
  237. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawFrozenPaneBorderEventArgs.Width">
  238. <summary>
  239. <para>Gets the width of the frozen pane border line.
  240. </para>
  241. </summary>
  242. <value>A <see cref="T:System.Single"/> value that specifies the width of the frozen pane border line.
  243. </value>
  244. </member>
  245. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl">
  246. <summary>
  247. <para>Displays cell references and defined names specified in a worksheet.
  248. </para>
  249. </summary>
  250. </member>
  251. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.#ctor">
  252. <summary>
  253. <para>Initializes a new instance of the SpreadsheetNameBoxControl class with default settings.
  254. </para>
  255. </summary>
  256. </member>
  257. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.BeforeDispose">
  258. <summary>
  259. <para>Occurs before the SpreadsheetNameBoxControl control is released from memory.
  260. </para>
  261. </summary>
  262. </member>
  263. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.EditorTypeName">
  264. <summary>
  265. <para>Gets the class name of the editor.
  266. </para>
  267. </summary>
  268. <value>A System.String object identifying the class name.
  269. </value>
  270. </member>
  271. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.ItemDisplayMode">
  272. <summary>
  273. <para>Gets or sets a value indicating what items should appear in the Name Box list.
  274. </para>
  275. </summary>
  276. <value>A <see cref="?:DevExpress.XtraSpreadsheet.NameBoxItemDisplayMode"/> enumeration member specifying what items should be displayed in the drop-down list of the Name Box control.
  277. </value>
  278. </member>
  279. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.Properties">
  280. <summary>
  281. <para>Gets an object that contains settings specific to the <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl"/> control.
  282. </para>
  283. </summary>
  284. <value>A RepositoryItemNameBox object that contains settings for the current <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl"/>.
  285. </value>
  286. </member>
  287. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.ReadOnly">
  288. <summary>
  289. <para>Gets or sets a value indicating whether the SpreadsheetNameBoxControl's value can be changed by end-users.
  290. </para>
  291. </summary>
  292. <value>A <see cref="T:DevExpress.Utils.DefaultBoolean"/> enumeration value specifying the accessibility of the SpreadsheetNameBoxControl control.
  293. The default is <b>DefaultBoolean.Default</b>.
  294. </value>
  295. </member>
  296. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.ReadOnlyChanged">
  297. <summary>
  298. <para>Occurs when the value of the <see cref="P:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.ReadOnly"/> property has changed.
  299. </para>
  300. </summary>
  301. </member>
  302. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetNameBoxControl.SpreadsheetControl">
  303. <summary>
  304. <para>Gets or sets the SpreadsheetControl to which the <b>Name Box</b> is bound.
  305. </para>
  306. </summary>
  307. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetControl"/> with which the <b>Name Box</b> interacts.
  308. </value>
  309. </member>
  310. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl">
  311. <summary>
  312. <para>Displays the content of the active cell and is used to view, enter and edit formulas and cell data in the SpreadsheetControl.
  313. </para>
  314. </summary>
  315. </member>
  316. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.#ctor">
  317. <summary>
  318. <para>Initializes a new instance of the SpreadsheetFormulaBarControl class with default settings.
  319. </para>
  320. </summary>
  321. </member>
  322. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.BeforeDispose">
  323. <summary>
  324. <para>Occurs before the SpreadsheetFormulaBarControl control is released from memory.
  325. </para>
  326. </summary>
  327. </member>
  328. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.BeforeEnter">
  329. <summary>
  330. <para>Occurs before the SpreadsheetFormulaBarControl is entered.
  331. </para>
  332. </summary>
  333. </member>
  334. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.CancelButtonClick">
  335. <summary>
  336. <para>Occurs when the <b>Cancel</b> button on the <b>Formula Bar</b> has been clicked.
  337. </para>
  338. </summary>
  339. </member>
  340. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.ExecuteResourceNavigatorAction(DevExpress.XtraEditors.NavigatorButtonType)">
  341. <summary>
  342. <para>Executes the command corresponding to one of the SpreadsheetFormularBarControl's buttons.
  343. </para>
  344. </summary>
  345. <param name="type">
  346. One of the <see cref="T:DevExpress.XtraEditors.NavigatorButtonType"/> enumeration values that is the type of button displayed in the <b>Formula Bar</b>.
  347. </param>
  348. <returns><b>true</b>, if the command is executed; otherwise, <b>false</b>.
  349. </returns>
  350. </member>
  351. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.Expanded">
  352. <summary>
  353. <para>Gets or sets whether the <b>Formula Bar</b> is expanded or collapsed.
  354. </para>
  355. </summary>
  356. <value><b>true</b>, if the <b>Formula Bar</b> is expanded; otherwise, <b>false</b>.
  357. </value>
  358. </member>
  359. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.InsertFunctionButtonClick">
  360. <summary>
  361. <para>Occurs when the <b>Insert Function</b> button on the <b>Formula Bar</b> has been clicked.
  362. </para>
  363. </summary>
  364. </member>
  365. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.IsResourceNavigatorActionEnabled(DevExpress.XtraEditors.NavigatorButtonType)">
  366. <summary>
  367. <para>Determines whether the specified button on the <b>Formula Bar</b> is enabled.
  368. </para>
  369. </summary>
  370. <param name="type">
  371. One of the <see cref="T:DevExpress.XtraEditors.NavigatorButtonType"/> enumeration values that is the type of button displayed in the <b>Formula Bar</b>.
  372. </param>
  373. <returns><b>true</b>, if the button is enabled; otherwise, <b>false</b>.
  374. </returns>
  375. </member>
  376. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.KeyDown">
  377. <summary>
  378. <para>Occurs when a key is pressed while the SpreadsheetFormulaBarControl has focus.
  379. </para>
  380. </summary>
  381. </member>
  382. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.OkButtonClick">
  383. <summary>
  384. <para>Occurs when the <b>Enter</b> button on the <b>Formula Bar</b> has been clicked.
  385. </para>
  386. </summary>
  387. </member>
  388. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.Rollback">
  389. <summary>
  390. <para>Occurs before the user input is canceled and the modified value is replaced with a value before modification.
  391. </para>
  392. </summary>
  393. </member>
  394. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetFormulaBarControl.SpreadsheetControl">
  395. <summary>
  396. <para>Gets or sets the SpreadsheetControl to which the <b>Formula Bar</b> is bound.
  397. </para>
  398. </summary>
  399. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetControl"/> with which the <b>Formula Bar</b> interacts.
  400. </value>
  401. </member>
  402. <member name="T:DevExpress.XtraSpreadsheet.Services.ObjectDataSourceValidationService">
  403. <summary>
  404. <para>Default service that validates the <see cref="T:DevExpress.DataAccess.ObjectBinding.ObjectDataSource"/> data sources before using them in the document.
  405. </para>
  406. </summary>
  407. </member>
  408. <member name="M:DevExpress.XtraSpreadsheet.Services.ObjectDataSourceValidationService.#ctor(DevExpress.XtraSpreadsheet.SpreadsheetControl)">
  409. <summary>
  410. <para>Initializes a new instance of the ObjectDataSourceValidationService class with the default settings.
  411. </para>
  412. </summary>
  413. <param name="control">
  414. A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetControl"/> instance.
  415. </param>
  416. </member>
  417. <member name="M:DevExpress.XtraSpreadsheet.Services.ObjectDataSourceValidationService.Validate(System.Collections.Generic.IEnumerable`1)">
  418. <summary>
  419. <para>Provides default validation of the specified <see cref="T:DevExpress.DataAccess.ObjectBinding.ObjectDataSource"/> data objects before data retrieval.
  420. </para>
  421. </summary>
  422. <param name="dataSources">
  423. A <see cref="T:System.Collections.Generic.IEnumerable`1[[DevExpress.DataAccess.ObjectBinding.ObjectDataSource]]"/> collection of <see cref="T:DevExpress.DataAccess.ObjectBinding.ObjectDataSource"/> instances to validate.
  424. </param>
  425. </member>
  426. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetTabSelectorOptions">
  427. <summary>
  428. <para>Contains options which can be specified for the <b>Sheet Tab Selector</b> of the SpreadsheetControl.
  429. </para>
  430. </summary>
  431. </member>
  432. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetTabSelectorOptions.#ctor">
  433. <summary>
  434. <para>Initializes a new instance of the SpreadsheetTabSelectorOptions class with default settings.
  435. </para>
  436. </summary>
  437. </member>
  438. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetTabSelectorOptions.Visibility">
  439. <summary>
  440. <para>Gets or sets a value that indicates whether the Sheet Tab Selector of the SpreadsheetControl should be displayed or hidden.
  441. </para>
  442. </summary>
  443. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetElementVisibility"/> enumeration value that specifies the visibility of the <b>Sheet Tab Selector</b>.
  444. </value>
  445. </member>
  446. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderEventHandler">
  447. <summary>
  448. <para>A method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeader"/> event of the SpreadsheetControl.
  449. </para>
  450. </summary>
  451. </member>
  452. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.CustomDrawRowHeaderEventArgs)">
  453. <summary>
  454. <para>A method that will handle the <b>CustomDrawRowHeader</b> event of the SpreadsheetControl.
  455. </para>
  456. </summary>
  457. <param name="sender">
  458. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  459. </param>
  460. <param name="e">
  461. A <see cref="T:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderEventArgs"/> object which contains event data.
  462. </param>
  463. </member>
  464. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderEventArgs">
  465. <summary>
  466. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeader"/> event.
  467. </para>
  468. </summary>
  469. </member>
  470. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderEventArgs.RowIndex">
  471. <summary>
  472. <para>Returns the column index of the row header being painted.
  473. </para>
  474. </summary>
  475. <value>An integer that is the zero-based worksheet row index.
  476. </value>
  477. </member>
  478. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderBackgroundEventHandler">
  479. <summary>
  480. <para>A method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeaderBackground"/> event of the SpreadsheetControl.
  481. </para>
  482. </summary>
  483. </member>
  484. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderBackgroundEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.CustomDrawRowHeaderBackgroundEventArgs)">
  485. <summary>
  486. <para>A method that will handle the <b>CustomDrawRowHeaderBackground</b> event of the SpreadsheetControl.
  487. </para>
  488. </summary>
  489. <param name="sender">
  490. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  491. </param>
  492. <param name="e">
  493. A <see cref="T:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderBackgroundEventArgs"/> object which contains event data.
  494. </param>
  495. </member>
  496. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderBackgroundEventArgs">
  497. <summary>
  498. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeaderBackground"/> event.
  499. </para>
  500. </summary>
  501. </member>
  502. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawRowHeaderBackgroundEventArgs.RowIndex">
  503. <summary>
  504. <para>Returns the row index of the column header being painted.
  505. </para>
  506. </summary>
  507. <value>An integer that is the zero-based worksheet row index.
  508. </value>
  509. </member>
  510. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase">
  511. <summary>
  512. <para>Represents the base class for classes that provide data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeaderBackground"/>, <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeader"/>, <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeaderBackground"/> and <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeader"/> events of the SpreadsheetControl.
  513. </para>
  514. </summary>
  515. </member>
  516. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.Appearance">
  517. <summary>
  518. <para>Provides access to the properties that control the appearance of a worksheet header.
  519. </para>
  520. </summary>
  521. <value>A <see cref="T:DevExpress.Utils.AppearanceObject"/> object which provides the appearance settings used to paint the header.
  522. </value>
  523. </member>
  524. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.BackColor">
  525. <summary>
  526. <para> Gets the background color of the header.
  527. </para>
  528. </summary>
  529. <value>A <see cref="T:System.Drawing.Color"/> object that identifies the background color of the header.
  530. </value>
  531. </member>
  532. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.Bounds">
  533. <summary>
  534. <para>Gets the header's bound rectangle.
  535. </para>
  536. </summary>
  537. <value>A <see cref="T:System.Drawing.Rectangle"/> object specifying the header boundaries.
  538. </value>
  539. </member>
  540. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.Control">
  541. <summary>
  542. <para>Provides access to the SpreadsheetControl that raised the event.
  543. </para>
  544. </summary>
  545. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetControl"/> object.
  546. </value>
  547. </member>
  548. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.Font">
  549. <summary>
  550. <para>Gets the font used to paint the header caption.
  551. </para>
  552. </summary>
  553. <value>A System.Drawing.Font object specifying font options (font name, size, color and etc.).
  554. </value>
  555. </member>
  556. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.ForeColor">
  557. <summary>
  558. <para>Gets the color used to paint the header caption text.
  559. </para>
  560. </summary>
  561. <value>A <see cref="T:System.Drawing.Color"/> object specifying the text color.
  562. </value>
  563. </member>
  564. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.IsHovered">
  565. <summary>
  566. <para>Gets whether a mouse is currently over the worksheet header.
  567. </para>
  568. </summary>
  569. <value><b>true</b>, if a row or column header is hovered over with a mouse; otherwise, <b>false</b>.
  570. </value>
  571. </member>
  572. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.IsSelected">
  573. <summary>
  574. <para>Gets whether the current column contains selected cell(s).
  575. </para>
  576. </summary>
  577. <value><b>true</b>, if the column contains selected cell(s); otherwise, <b>false</b>.
  578. </value>
  579. </member>
  580. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawHeaderEventArgsBase.Text">
  581. <summary>
  582. <para>Gets the text of the header caption.
  583. </para>
  584. </summary>
  585. <value>A string that is the header caption.
  586. </value>
  587. </member>
  588. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderEventHandler">
  589. <summary>
  590. <para>A method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeader"/> event of the SpreadsheetControl.
  591. </para>
  592. </summary>
  593. </member>
  594. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderEventArgs)">
  595. <summary>
  596. <para>A method that will handle the <b>CustomDrawColumnHeader</b> event of the SpreadsheetControl.
  597. </para>
  598. </summary>
  599. <param name="sender">
  600. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  601. </param>
  602. <param name="e">
  603. A <see cref="T:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderEventArgs"/> object which contains event data.
  604. </param>
  605. </member>
  606. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderEventArgs">
  607. <summary>
  608. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeader"/> event.
  609. </para>
  610. </summary>
  611. </member>
  612. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderEventArgs.ColumnIndex">
  613. <summary>
  614. <para>Returns the column index of the column header being painted.
  615. </para>
  616. </summary>
  617. <value>An integer that is the zero-based worksheet column index.
  618. </value>
  619. </member>
  620. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderBackgroundEventHandler">
  621. <summary>
  622. <para>A method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeaderBackground"/> event of the SpreadsheetControl.
  623. </para>
  624. </summary>
  625. </member>
  626. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderBackgroundEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderBackgroundEventArgs)">
  627. <summary>
  628. <para>A method that will handle the <b>CustomDrawCellColumnHeaderBackground</b> event of the SpreadsheetControl.
  629. </para>
  630. </summary>
  631. <param name="sender">
  632. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  633. </param>
  634. <param name="e">
  635. A <see cref="T:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderBackgroundEventArgs"/> object which contains event data.
  636. </param>
  637. </member>
  638. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderBackgroundEventArgs">
  639. <summary>
  640. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeaderBackground"/> event.
  641. </para>
  642. </summary>
  643. </member>
  644. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawColumnHeaderBackgroundEventArgs.ColumnIndex">
  645. <summary>
  646. <para>Returns the column index of the column header being painted.
  647. </para>
  648. </summary>
  649. <value>An integer that is the zero-based worksheet column index.
  650. </value>
  651. </member>
  652. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetMenuType">
  653. <summary>
  654. <para>Lists values used to specify the type of the SpreadsheetControl's context menu.
  655. </para>
  656. </summary>
  657. </member>
  658. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.AutoFilter">
  659. <summary>
  660. <para>Specifies a context menu which can be invoked by clicking the <b>AutoFilter</b> drop-down arrow.
  661. </para>
  662. </summary>
  663. </member>
  664. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.Cell">
  665. <summary>
  666. <para>Specifies a context menu which can be invoked by right-clicking any cell in a worksheet.
  667. </para>
  668. </summary>
  669. </member>
  670. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.Chart">
  671. <summary>
  672. <para>Specifies a context menu which can be invoked by right-clicking a chart in a worksheet.
  673. </para>
  674. </summary>
  675. </member>
  676. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.ColumnHeading">
  677. <summary>
  678. <para>Specifies a context menu which can be invoked by right-clicking a column header.
  679. </para>
  680. </summary>
  681. </member>
  682. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.DrawingObjects">
  683. <summary>
  684. <para>Specifies a context menu which can be invoked by right-clicking a drawing object when a worksheet contains several drawing objects, such as pictures or charts.
  685. </para>
  686. </summary>
  687. </member>
  688. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.None">
  689. <summary>
  690. <para>Specifies no menu.
  691. </para>
  692. </summary>
  693. </member>
  694. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.Picture">
  695. <summary>
  696. <para>Specifies a context menu which can be invoked by right-clicking a picture embedded in a worksheet.
  697. </para>
  698. </summary>
  699. </member>
  700. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.PivotTable">
  701. <summary>
  702. <para>Specifies a context menu which can be invoked by right-clicking any cell in a pivot table.
  703. </para>
  704. </summary>
  705. </member>
  706. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.PivotTableAutoFilter">
  707. <summary>
  708. <para>Specifies a context menu which can be invoked by clicking the <b>AutoFilter</b> drop-down arrow on the row or column label of a pivot table.
  709. </para>
  710. </summary>
  711. </member>
  712. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.RowHeading">
  713. <summary>
  714. <para>Specifies a context menu which can be invoked by right-clicking a row header.
  715. </para>
  716. </summary>
  717. </member>
  718. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.SelectAllButton">
  719. <summary>
  720. <para>Specifies a context menu which can be invoked by right-clicking the <b>Select All</b> button in the upper-left corner of a worksheet.
  721. </para>
  722. </summary>
  723. </member>
  724. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetMenuType.SheetTab">
  725. <summary>
  726. <para>Specifies a context menu which can be invoked by right-clicking a worksheet tab.
  727. </para>
  728. </summary>
  729. </member>
  730. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetScrollbarVisibility">
  731. <summary>
  732. <para>Lists values used to specify the visibility of a scrollbar in the SpreadsheetControl.
  733. </para>
  734. </summary>
  735. </member>
  736. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetScrollbarVisibility.Auto">
  737. <summary>
  738. <para>The scrollbar is hidden or displayed depending on the workbook display options.
  739. </para>
  740. </summary>
  741. </member>
  742. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetScrollbarVisibility.Hidden">
  743. <summary>
  744. <para>The scrollbar is always hidden.
  745. </para>
  746. </summary>
  747. </member>
  748. <member name="F:DevExpress.XtraSpreadsheet.SpreadsheetScrollbarVisibility.Visible">
  749. <summary>
  750. <para>The scrollbar is always displayed.
  751. </para>
  752. </summary>
  753. </member>
  754. <member name="T:DevExpress.XtraSpreadsheet.PopupMenuShowingEventHandler">
  755. <summary>
  756. <para>A method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.PopupMenuShowing"/> event of the SpreadsheetControl.
  757. </para>
  758. </summary>
  759. </member>
  760. <member name="M:DevExpress.XtraSpreadsheet.PopupMenuShowingEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.PopupMenuShowingEventArgs)">
  761. <summary>
  762. <para>A method that will handle the <b>PopupMenuShowing</b> event of the SpreadsheetControl.
  763. </para>
  764. </summary>
  765. <param name="sender">
  766. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  767. </param>
  768. <param name="e">
  769. A <see cref="T:DevExpress.XtraSpreadsheet.PopupMenuShowingEventArgs"/> object which contains event data.
  770. </param>
  771. </member>
  772. <member name="T:DevExpress.XtraSpreadsheet.PopupMenuShowingEventArgs">
  773. <summary>
  774. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.PopupMenuShowing"/> event.
  775. </para>
  776. </summary>
  777. </member>
  778. <member name="M:DevExpress.XtraSpreadsheet.PopupMenuShowingEventArgs.#ctor(DevExpress.XtraSpreadsheet.Menu.SpreadsheetPopupMenu,DevExpress.XtraSpreadsheet.SpreadsheetMenuType)">
  779. <summary>
  780. <para>Initializes a new instance of the PopupMenuShowingEventArgs class with the specified parameters.
  781. </para>
  782. </summary>
  783. <param name="menu">
  784. The SpreadsheetPopupMenu object which represents the context menu to be invoked.
  785. </param>
  786. <param name="menuType">
  787. One of the <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetMenuType"/> enumeration values specifying the type of the context menu.
  788. </param>
  789. </member>
  790. <member name="P:DevExpress.XtraSpreadsheet.PopupMenuShowingEventArgs.Menu">
  791. <summary>
  792. <para>Gets or sets the SpreadsheetControl's popup menu for which the event was raised.
  793. </para>
  794. </summary>
  795. <value>The SpreadsheetPopupMenu object which represents the current context menu.
  796. </value>
  797. </member>
  798. <member name="P:DevExpress.XtraSpreadsheet.PopupMenuShowingEventArgs.MenuType">
  799. <summary>
  800. <para>Returns the type of the current SpreadsheetControl's popup menu.
  801. </para>
  802. </summary>
  803. <value>One of the <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetMenuType"/> enumeration values.
  804. </value>
  805. </member>
  806. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetHorizontalScrollbarOptions">
  807. <summary>
  808. <para>Contains options for the horizontal scrollbar of the SpreadsheetControl.
  809. </para>
  810. </summary>
  811. </member>
  812. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetHorizontalScrollbarOptions.#ctor">
  813. <summary>
  814. <para>Initializes a new instance of the SpreadsheetHorizontalScrollbarOptions class with default settings.
  815. </para>
  816. </summary>
  817. </member>
  818. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetVerticalScrollbarOptions">
  819. <summary>
  820. <para>Contains options for the vertical scrollbar of the SpreadsheetControl.
  821. </para>
  822. </summary>
  823. </member>
  824. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetVerticalScrollbarOptions.#ctor">
  825. <summary>
  826. <para>Initializes a new instance of the SpreadsheetVerticalScrollbarOptions class with default settings.
  827. </para>
  828. </summary>
  829. </member>
  830. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetScrollbarOptions">
  831. <summary>
  832. <para>Represents the base class for scrollbar options.
  833. </para>
  834. </summary>
  835. </member>
  836. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetScrollbarOptions.Visibility">
  837. <summary>
  838. <para>Gets or sets a value that indicates whether the SpreadsheetControl's scrollbar should be displayed or hidden.
  839. </para>
  840. </summary>
  841. <value>One of the <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetScrollbarVisibility"/> enumeration values.
  842. </value>
  843. </member>
  844. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawObjectEventsArgs">
  845. <summary>
  846. <para>Represents the base class for all classes that provide data for the custom draw events.
  847. </para>
  848. </summary>
  849. </member>
  850. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawObjectEventsArgs.Cache">
  851. <summary>
  852. <para>Gets an object which specifies the storage for the pens, fonts and brushes.
  853. </para>
  854. </summary>
  855. <value>A <see cref="T:DevExpress.Utils.Drawing.GraphicsCache"/> object.
  856. </value>
  857. </member>
  858. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawObjectEventsArgs.DrawDefault">
  859. <summary>
  860. <para>Renders the element using the default drawing mechanism.
  861. </para>
  862. </summary>
  863. </member>
  864. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawObjectEventsArgs.Graphics">
  865. <summary>
  866. <para>Gets an object used for painting.
  867. </para>
  868. </summary>
  869. <value>A <see cref="T:System.Drawing.Graphics"/> object which provides a means for painting.
  870. </value>
  871. </member>
  872. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawObjectEventsArgs.Handled">
  873. <summary>
  874. <para>Gets or sets whether an event was handled. If it was handled, the default actions are not required.
  875. </para>
  876. </summary>
  877. <value><b>true</b>, if default painting isn't required; otherwise, <b>false</b>.
  878. </value>
  879. </member>
  880. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgsBase">
  881. <summary>
  882. <para>Provides data for the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawCell"/> event.
  883. </para>
  884. </summary>
  885. </member>
  886. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgsBase.Bounds">
  887. <summary>
  888. <para>Returns the bounding rectangle of the drawing area.
  889. </para>
  890. </summary>
  891. <value>A <see cref="T:System.Drawing.Rectangle"/> value which specifies the object's bounding rectangle.
  892. </value>
  893. </member>
  894. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgsBase.Cell">
  895. <summary>
  896. <para>Gets the worksheet cell being painted.
  897. </para>
  898. </summary>
  899. <value>A <see cref="T:DevExpress.Spreadsheet.Cell"/> object that is the worksheet cell.
  900. </value>
  901. </member>
  902. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgsBase.FillBounds">
  903. <summary>
  904. <para>Returns the bounding rectangle of the drawing area for painting the cell background.
  905. </para>
  906. </summary>
  907. <value>A <see cref="T:System.Drawing.Rectangle"/> value which specifies the object's bounding rectangle.
  908. </value>
  909. </member>
  910. <member name="T:DevExpress.XtraSpreadsheet.WorksheetDisplayArea">
  911. <summary>
  912. <para>An object that enables you to specify the visible worksheet area.
  913. </para>
  914. </summary>
  915. </member>
  916. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.#ctor(DevExpress.XtraSpreadsheet.Internal.InnerSpreadsheetControl)">
  917. <summary>
  918. <para>Initializes a new instance of the WorksheetDisplayArea class with the specified settings.
  919. </para>
  920. </summary>
  921. <param name="innerControl">
  922. </param>
  923. </member>
  924. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.GetColumnCount(System.String)">
  925. <summary>
  926. <para>Returns the number of visible columns in the specified worksheet.
  927. </para>
  928. </summary>
  929. <param name="worksheetName">
  930. A string value specifying the worksheet name in the worksheet collection.
  931. </param>
  932. <returns>An integer that represents the number of columns currently visible in a worksheet.
  933. </returns>
  934. </member>
  935. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.GetColumnCount(System.Int32)">
  936. <summary>
  937. <para>Returns the number of visible columns in the specified worksheet.
  938. </para>
  939. </summary>
  940. <param name="worksheetIndex">
  941. An integer that is the zero-based index of the worksheet in the worksheet collection.
  942. </param>
  943. <returns>An integer that represents the number of columns currently visible in a worksheet.
  944. </returns>
  945. </member>
  946. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.GetRowCount(System.String)">
  947. <summary>
  948. <para>Returns the number of visible rows in the specified worksheet.
  949. </para>
  950. </summary>
  951. <param name="worksheetName">
  952. A string value specifying the worksheet name in the worksheet collection.
  953. </param>
  954. <returns>An integer that represents the number of rows currently visible in a worksheet.
  955. </returns>
  956. </member>
  957. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.GetRowCount(System.Int32)">
  958. <summary>
  959. <para>Returns the number of visible rows in the specified worksheet.
  960. </para>
  961. </summary>
  962. <param name="worksheetIndex">
  963. An integer that is the zero-based index of the worksheet in the worksheet collection.
  964. </param>
  965. <returns>An integer that represents the number of rows currently visible in a worksheet.
  966. </returns>
  967. </member>
  968. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.Reset(System.String)">
  969. <summary>
  970. <para>Displays all columns and rows in the specified worksheet.
  971. </para>
  972. </summary>
  973. <param name="worksheetName">
  974. A string value specifying the worksheet name in the worksheet collection.
  975. </param>
  976. </member>
  977. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.Reset(System.Int32)">
  978. <summary>
  979. <para>Displays all columns and rows in the specified worksheet.
  980. </para>
  981. </summary>
  982. <param name="worksheetIndex">
  983. An integer that is the zero-based index of the worksheet in the worksheet collection.
  984. </param>
  985. </member>
  986. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.SetSize(System.String,System.Int32,System.Int32)">
  987. <summary>
  988. <para>Defines the number of visible columns and rows for the specified worksheet.
  989. </para>
  990. </summary>
  991. <param name="worksheetName">
  992. A string value specifying the name of the worksheet whose visible area should be restricted.
  993. </param>
  994. <param name="maxColumnCount">
  995. An integer that represents the maximum number of columns to be displayed in a worksheet. The value must be a whole number between 1 and 16,384.
  996. </param>
  997. <param name="maxRowCount">
  998. An integer that represents the maximum number of rows to be displayed in a worksheet. The value must be a whole number between 1 and 1,048,576.
  999. </param>
  1000. </member>
  1001. <member name="M:DevExpress.XtraSpreadsheet.WorksheetDisplayArea.SetSize(System.Int32,System.Int32,System.Int32)">
  1002. <summary>
  1003. <para>Defines the number of visible columns and rows for the specified worksheet.
  1004. </para>
  1005. </summary>
  1006. <param name="worksheetIndex">
  1007. An integer that is the zero-based index of the worksheet whose visible area should be restricted.
  1008. </param>
  1009. <param name="maxColumnCount">
  1010. An integer that represents the maximum number of columns to be displayed in a worksheet. The value must be a whole number between 1 and 16,384.
  1011. </param>
  1012. <param name="maxRowCount">
  1013. An integer that represents the maximum number of rows to be displayed in a worksheet. The value must be a whole number between 1 and 1,048,576.
  1014. </param>
  1015. </member>
  1016. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawCellEventHandler">
  1017. <summary>
  1018. <para>A method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawCell"/> event of the SpreadsheetControl.
  1019. </para>
  1020. </summary>
  1021. </member>
  1022. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawCellEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs)">
  1023. <summary>
  1024. <para>A method that will handle the <b>CustomDrawCell</b> event of the SpreadsheetControl.
  1025. </para>
  1026. </summary>
  1027. <param name="sender">
  1028. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  1029. </param>
  1030. <param name="e">
  1031. A <see cref="T:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs"/> object which contains event data.
  1032. </param>
  1033. </member>
  1034. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs">
  1035. <summary>
  1036. <para>Provides data for the SpreadsheetControl.CustomDrawCell event.
  1037. </para>
  1038. </summary>
  1039. </member>
  1040. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs.Font">
  1041. <summary>
  1042. <para>Gets the font attributes of the painted cell.
  1043. </para>
  1044. </summary>
  1045. <value>A System.Drawing.Font object specifying the font options (font name, size, color and etc.).
  1046. </value>
  1047. </member>
  1048. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs.ForeColor">
  1049. <summary>
  1050. <para>Gets or sets the color of the text within the painted cell.
  1051. </para>
  1052. </summary>
  1053. <value>A System.Drawing.Color object specifying the foreground color.
  1054. </value>
  1055. </member>
  1056. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawCellEventArgs.Text">
  1057. <summary>
  1058. <para>Gets or sets the painted cell's text.
  1059. </para>
  1060. </summary>
  1061. <value>A System.String object specifying the text of the painted cell.
  1062. </value>
  1063. </member>
  1064. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawCellBackgroundEventHandler">
  1065. <summary>
  1066. <para>Represents a method that will handle the <see cref="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawCellBackground"/> event.
  1067. </para>
  1068. </summary>
  1069. </member>
  1070. <member name="M:DevExpress.XtraSpreadsheet.CustomDrawCellBackgroundEventHandler.Invoke(System.Object,DevExpress.XtraSpreadsheet.CustomDrawCellBackgroundEventArgs)">
  1071. <summary>
  1072. <para>A method that will handle the <b>CustomDrawCellBackground</b> event of the SpreadsheetControl.
  1073. </para>
  1074. </summary>
  1075. <param name="sender">
  1076. The event source. This parameter identifies the SpreadsheetControl which raised the event.
  1077. </param>
  1078. <param name="e">
  1079. A <see cref="T:DevExpress.XtraSpreadsheet.CustomDrawCellBackgroundEventArgs"/> object which contains event data.
  1080. </param>
  1081. </member>
  1082. <member name="T:DevExpress.XtraSpreadsheet.CustomDrawCellBackgroundEventArgs">
  1083. <summary>
  1084. <para>Provides data for the SpreadsheetControl.CustomDrawCellBackground event.
  1085. </para>
  1086. </summary>
  1087. </member>
  1088. <member name="P:DevExpress.XtraSpreadsheet.CustomDrawCellBackgroundEventArgs.BackColor">
  1089. <summary>
  1090. <para>Gets or sets the background color of the painted cell.
  1091. </para>
  1092. </summary>
  1093. <value>A <see cref="T:System.Drawing.Color"/> structure that specifies the cell's background color.
  1094. </value>
  1095. </member>
  1096. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions">
  1097. <summary>
  1098. <para>Contains various options which can be specified for the SpreadsheetControl.
  1099. </para>
  1100. </summary>
  1101. </member>
  1102. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.#ctor(DevExpress.XtraSpreadsheet.Internal.InnerSpreadsheetDocumentServer)">
  1103. <summary>
  1104. <para>Initializes a new instance of the SpreadsheetControlOptions class with the specified settings.
  1105. </para>
  1106. </summary>
  1107. <param name="documentServer">
  1108. </param>
  1109. </member>
  1110. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.Behavior">
  1111. <summary>
  1112. <para>Provides access to an object that enables you to apply restrictions to different spreadsheet operations.
  1113. </para>
  1114. </summary>
  1115. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetBehaviorOptions"/> class instance containing restriction specifications.
  1116. </value>
  1117. </member>
  1118. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.DataSourceOptions">
  1119. <summary>
  1120. <para>Allows you to specify whether to prohibit the ObjectDataSource data retrieval, prompt the user or silently load the data.
  1121. </para>
  1122. </summary>
  1123. <value>
  1124. </value>
  1125. </member>
  1126. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.DataSourceWizard">
  1127. <summary>
  1128. <para>Provides access to the customization options of the Data Source Wizard.
  1129. </para>
  1130. </summary>
  1131. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetDataSourceWizardOptions"/> object containing options which affect the layout and behavior of the <b>Data Source Wizard</b> and <b>Query Builder</b>.
  1132. </value>
  1133. </member>
  1134. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.HorizontalScrollbar">
  1135. <summary>
  1136. <para>Provides access to the options specific to the horizontal scrollbar of the SpreadsheetControl.
  1137. </para>
  1138. </summary>
  1139. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetHorizontalScrollbarOptions"/> object used to specify options for the horizontal scrollbar.
  1140. </value>
  1141. </member>
  1142. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.PivotTableFieldList">
  1143. <summary>
  1144. <para>Provides access to the options used to specify the size and starting position of the PivotTable Field List pane at runtime.
  1145. </para>
  1146. </summary>
  1147. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetPivotTableFieldListOptions"/> object containing the <b>PivotTable Field List</b> options.
  1148. </value>
  1149. </member>
  1150. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.Print">
  1151. <summary>
  1152. <para>Provides access to options used to generate and preview a printed document in the SpreadsheetControl.
  1153. </para>
  1154. </summary>
  1155. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetPrintOptions"/> object containing options for previewing and printing a document in the SpreadsheetControl.
  1156. </value>
  1157. </member>
  1158. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.TabSelector">
  1159. <summary>
  1160. <para>Provides access to the options specific to the <b>Sheet Tab Selector</b> of the SpreadsheetControl.
  1161. </para>
  1162. </summary>
  1163. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetTabSelectorOptions"/> object used to specify options for the Sheet Tab Selector.
  1164. </value>
  1165. </member>
  1166. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.VerticalScrollbar">
  1167. <summary>
  1168. <para>Provides access to the options specific to the vertical scrollbar of the SpreadsheetControl.
  1169. </para>
  1170. </summary>
  1171. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetVerticalScrollbarOptions"/> object used to specify options for the vertical scrollbar.
  1172. </value>
  1173. </member>
  1174. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions.View">
  1175. <summary>
  1176. <para>Gets the <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetControl"/>'s view options.
  1177. </para>
  1178. </summary>
  1179. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetViewOptions"/> object that specifies the display settings for the SpreadsheetControl.
  1180. </value>
  1181. </member>
  1182. <member name="T:DevExpress.XtraSpreadsheet.SpreadsheetControl">
  1183. <summary>
  1184. <para>Emulates the Microsoft Excel look and feel and allows you to create, load, edit, save and print spreadsheet documents.
  1185. </para>
  1186. </summary>
  1187. </member>
  1188. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.#ctor">
  1189. <summary>
  1190. <para>Initializes a new instance of the SpreadsheetControl class with default settings.
  1191. </para>
  1192. </summary>
  1193. </member>
  1194. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.About">
  1195. <summary>
  1196. <para>Invokes the <b>About</b> dialog box.
  1197. </para>
  1198. </summary>
  1199. </member>
  1200. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.AcceptsEscape">
  1201. <summary>
  1202. <para>Gets or sets a value indicating whether pressing the ESC key is processed by the SpreadsheetControl.
  1203. </para>
  1204. </summary>
  1205. <value><b>true</b> if the input ESC key is processed by the SpreadsheetControl, otherwise <b>false</b>.
  1206. </value>
  1207. </member>
  1208. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.AcceptsReturn">
  1209. <summary>
  1210. <para>Gets or sets a value indicating whether pressing the RETURN key is processed by the SpreadsheetControl.
  1211. </para>
  1212. </summary>
  1213. <value><b>true</b> if the input RETURN key is processed by the SpreadsheetControl, otherwise <b>false</b>.
  1214. </value>
  1215. </member>
  1216. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.AcceptsTab">
  1217. <summary>
  1218. <para>Gets or sets a value indicating whether pressing the TAB key is processed by the SpreadsheetControl instead of moving the focus to the next control in the tab order.
  1219. </para>
  1220. </summary>
  1221. <value><b>true</b> if the input TAB key is processed by the SpreadsheetControl, otherwise <b>false</b>.
  1222. </value>
  1223. </member>
  1224. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ActiveCell">
  1225. <summary>
  1226. <para>Gets an active cell in the active worksheet.
  1227. </para>
  1228. </summary>
  1229. <value>A <see cref="T:DevExpress.Spreadsheet.Cell"/> object that specifies an active cell in the worksheet that is currently active.
  1230. </value>
  1231. </member>
  1232. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ActiveChartSheet">
  1233. <summary>
  1234. <para>Gets the chart sheet that is currently displayed in the SpreadsheetControl.
  1235. </para>
  1236. </summary>
  1237. <value>A <see cref="T:DevExpress.Spreadsheet.ChartSheet"/> object that specifies the active chart sheet.
  1238. </value>
  1239. </member>
  1240. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ActiveSheet">
  1241. <summary>
  1242. <para>Gets the sheet that is currently displayed in the SpreadsheetControl.
  1243. </para>
  1244. </summary>
  1245. <value>A <see cref="T:DevExpress.Spreadsheet.Sheet"/> descendant that specifies the active worksheet or chart sheet.
  1246. </value>
  1247. </member>
  1248. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ActiveSheetChanged">
  1249. <summary>
  1250. <para>Occurs after an active worksheet has been changed via the SpreadsheetControl's UI.
  1251. </para>
  1252. </summary>
  1253. </member>
  1254. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ActiveSheetChanging">
  1255. <summary>
  1256. <para>Occurs when an active worksheet is about to be changed via the SpreadsheetControl's UI.
  1257. </para>
  1258. </summary>
  1259. </member>
  1260. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ActiveView">
  1261. <summary>
  1262. <para>Provides access to a SpreadsheetView object that contains layout information. This member supports the internal infrastructure and is not intended to be used directly from your code.
  1263. </para>
  1264. </summary>
  1265. <value>A DevExpress.Spreadsheet.SpreadsheetView object.
  1266. </value>
  1267. </member>
  1268. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ActiveWorksheet">
  1269. <summary>
  1270. <para>Gets the worksheet that is currently displayed in the SpreadsheetControl.
  1271. </para>
  1272. </summary>
  1273. <value>A <see cref="T:DevExpress.Spreadsheet.Worksheet"/> object that specifies the active worksheet.
  1274. </value>
  1275. </member>
  1276. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.AddService(System.Type,System.ComponentModel.Design.ServiceCreatorCallback)">
  1277. <summary>
  1278. <para>Adds the specified service to the service container.
  1279. </para>
  1280. </summary>
  1281. <param name="serviceType">
  1282. The type of service to add.
  1283. </param>
  1284. <param name="callback">
  1285. A callback object that is used to create the service. This allows a service to be declared as available, but delays the creation of the object until the service is requested.
  1286. </param>
  1287. </member>
  1288. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.AddService(System.Type,System.Object)">
  1289. <summary>
  1290. <para>Adds the specified service to the service container.
  1291. </para>
  1292. </summary>
  1293. <param name="serviceType">
  1294. The type of service to add.
  1295. </param>
  1296. <param name="serviceInstance">
  1297. An instance of the service type to add. This object must implement or inherit from the type indicated by the serviceType parameter.
  1298. </param>
  1299. </member>
  1300. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.AddService(System.Type,System.Object,System.Boolean)">
  1301. <summary>
  1302. <para>Adds the specified service to the service container.
  1303. </para>
  1304. </summary>
  1305. <param name="serviceType">
  1306. The type of service to add.
  1307. </param>
  1308. <param name="serviceInstance">
  1309. An instance of the service type to add. This object must implement or inherit from the type indicated by the serviceType parameter.
  1310. </param>
  1311. <param name="promote">
  1312. <b>true</b>, to promote this request to any parent service containers; otherwise, <b>false</b>.
  1313. </param>
  1314. </member>
  1315. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.AddService(System.Type,System.ComponentModel.Design.ServiceCreatorCallback,System.Boolean)">
  1316. <summary>
  1317. <para>Adds the specified service to the service container.
  1318. </para>
  1319. </summary>
  1320. <param name="serviceType">
  1321. The type of service to add.
  1322. </param>
  1323. <param name="callback">
  1324. A callback object that is used to create the service. This allows a service to be declared as available, but delays the creation of the object until the service is requested.
  1325. </param>
  1326. <param name="promote">
  1327. <b>true</b>, to promote this request to any parent service containers; otherwise, <b>false</b>.
  1328. </param>
  1329. </member>
  1330. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.AllowDrop">
  1331. <summary>
  1332. <para>Overrides the System.Windows.Forms.Control.AllowDrop property.
  1333. </para>
  1334. </summary>
  1335. <value><b>true</b>, if drag-and-drop operations are allowed in the SpreadsheetControl; otherwise, <b>false</b>.
  1336. </value>
  1337. </member>
  1338. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.AssignShortcutKeyToCommand(System.Windows.Forms.Keys,System.Windows.Forms.Keys,DevExpress.XtraSpreadsheet.Commands.SpreadsheetCommandId)">
  1339. <summary>
  1340. <para>Assigns a shortcut key to a command.
  1341. </para>
  1342. </summary>
  1343. <param name="key">
  1344. A System.Windows.Forms.Keys enumeration member specifying a key to assign.
  1345. </param>
  1346. <param name="modifier">
  1347. A System.Windows.Forms.Keys enumeration member specifying a modifier key.
  1348. </param>
  1349. <param name="commandId">
  1350. A SpreadsheetCommandId enumeration member specifying a command.
  1351. </param>
  1352. </member>
  1353. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.BackColor">
  1354. <summary>
  1355. <para>This property is not supported by the SpreadsheetControl class.
  1356. </para>
  1357. </summary>
  1358. <value>
  1359. </value>
  1360. </member>
  1361. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.BackgroundImage">
  1362. <summary>
  1363. <para>This property has no effect on the SpreadsheetControl.
  1364. </para>
  1365. </summary>
  1366. <value>
  1367. </value>
  1368. </member>
  1369. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.BackgroundImageLayout">
  1370. <summary>
  1371. <para>This property has no effect on the SpreadsheetControl.
  1372. </para>
  1373. </summary>
  1374. <value>
  1375. </value>
  1376. </member>
  1377. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.BeforeDispose">
  1378. <summary>
  1379. <para>Occurs before the SpreadsheetControl control is released from memory.
  1380. </para>
  1381. </summary>
  1382. </member>
  1383. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.BeforeExport">
  1384. <summary>
  1385. <para>Occurs before the document is saved (exported to a certain format).
  1386. </para>
  1387. </summary>
  1388. </member>
  1389. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.BeforeImport">
  1390. <summary>
  1391. <para>Occurs before a document is loaded (imported from an external source).
  1392. </para>
  1393. </summary>
  1394. </member>
  1395. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.BeforePrintSheet">
  1396. <summary>
  1397. <para>Provides the capability to prevent printing of the required worksheets in a workbook.
  1398. </para>
  1399. </summary>
  1400. </member>
  1401. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.BeginUpdate">
  1402. <summary>
  1403. <para>Locks the SpreadsheetControl, preventing visual updates of the object and its elements until the <b>EndUpdate</b> or <b>CancelUpdate</b> method is called.
  1404. </para>
  1405. </summary>
  1406. </member>
  1407. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.BorderStyle">
  1408. <summary>
  1409. <para>Gets or sets the SpreadsheetControl's border style.
  1410. </para>
  1411. </summary>
  1412. <value>A <see cref="T:DevExpress.XtraEditors.Controls.BorderStyles"/> enumeration value specifying the border style for the SpreadsheetControl.
  1413. </value>
  1414. </member>
  1415. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.CancelUpdate">
  1416. <summary>
  1417. <para>Unlocks the SpreadsheetControl object after it has been locked by the <b>BeginUpdate</b> method, without causing an immediate visual update.
  1418. </para>
  1419. </summary>
  1420. </member>
  1421. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CellBeginEdit">
  1422. <summary>
  1423. <para>Occurs before the cell editor is opened.
  1424. </para>
  1425. </summary>
  1426. </member>
  1427. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CellCancelEdit">
  1428. <summary>
  1429. <para>Occurs before the cell editor is closed and the entered value is rolled back.
  1430. </para>
  1431. </summary>
  1432. </member>
  1433. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CellEndEdit">
  1434. <summary>
  1435. <para>Occurs before the cell editor is closed and the entered value is committed.
  1436. </para>
  1437. </summary>
  1438. </member>
  1439. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CellValueChanged">
  1440. <summary>
  1441. <para>Occurs after the cell content has been changed via the SpreadsheetControl UI.
  1442. </para>
  1443. </summary>
  1444. </member>
  1445. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.CircleInvalidData">
  1446. <summary>
  1447. <para>Displays circles around invalid data in a worksheet to which data validation is applied.
  1448. </para>
  1449. </summary>
  1450. </member>
  1451. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ClearValidationCircles">
  1452. <summary>
  1453. <para>Hides circles around invalid data in a worksheet to which data validation is applied.
  1454. </para>
  1455. </summary>
  1456. </member>
  1457. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Clipboard">
  1458. <summary>
  1459. <para>Provides access to the object used for working with the system Clipboard.
  1460. </para>
  1461. </summary>
  1462. <value>An object implementing the <see cref="T:DevExpress.Spreadsheet.IClipboardManager"/> interface.
  1463. </value>
  1464. </member>
  1465. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ClipboardDataObtained">
  1466. <summary>
  1467. <para>Occurs after data on the clipboard is obtained and recognized, but before data is actually pasted.
  1468. </para>
  1469. </summary>
  1470. </member>
  1471. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ClipboardDataPasted">
  1472. <summary>
  1473. <para>Occurs after data has been pasted from the clipboard onto a worksheet.
  1474. </para>
  1475. </summary>
  1476. </member>
  1477. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ClipboardDataPasting">
  1478. <summary>
  1479. <para> Occurs before data is pasted into destination cells.
  1480. </para>
  1481. </summary>
  1482. </member>
  1483. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.CloseCellEditor(DevExpress.XtraSpreadsheet.CellEditorEnterValueMode)">
  1484. <summary>
  1485. <para>Closes the cell editor.
  1486. </para>
  1487. </summary>
  1488. <param name="mode">
  1489. A <see cref="T:DevExpress.XtraSpreadsheet.CellEditorEnterValueMode"/> enumeration member.
  1490. </param>
  1491. <returns><b>true</b>, if the cell editor is closed successfully; otherwise, <b>false</b>.
  1492. </returns>
  1493. </member>
  1494. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ColumnsInserted">
  1495. <summary>
  1496. <para>Occurs after new columns have been added to a worksheet via the SpreadsheetControl's UI.
  1497. </para>
  1498. </summary>
  1499. </member>
  1500. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ColumnsInserting">
  1501. <summary>
  1502. <para>Occurs when new columns are about to be inserted into a worksheet.
  1503. </para>
  1504. </summary>
  1505. </member>
  1506. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ColumnsRemoved">
  1507. <summary>
  1508. <para>Occurs after columns have been deleted from a worksheet via the SpreadsheetControl's UI.
  1509. </para>
  1510. </summary>
  1511. </member>
  1512. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ColumnsRemoving">
  1513. <summary>
  1514. <para>Occurs when columns are about to be deleted from a worksheet.
  1515. </para>
  1516. </summary>
  1517. </member>
  1518. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CommentInserted">
  1519. <summary>
  1520. <para>Occurs when a comment is inserted.
  1521. </para>
  1522. </summary>
  1523. </member>
  1524. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CommentInserting">
  1525. <summary>
  1526. <para>Occurs before inserting a comment.
  1527. </para>
  1528. </summary>
  1529. </member>
  1530. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CommentRemoved">
  1531. <summary>
  1532. <para>Occurs when a comment is deleted.
  1533. </para>
  1534. </summary>
  1535. </member>
  1536. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CommentRemoving">
  1537. <summary>
  1538. <para>Occurs before deleting a comment.
  1539. </para>
  1540. </summary>
  1541. </member>
  1542. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ContentChanged">
  1543. <summary>
  1544. <para>Occurs when the document content is changed.
  1545. </para>
  1546. </summary>
  1547. </member>
  1548. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CopiedRangePasted">
  1549. <summary>
  1550. <para>Occurs after the range content has been pasted into target cells.
  1551. </para>
  1552. </summary>
  1553. </member>
  1554. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CopiedRangePasting">
  1555. <summary>
  1556. <para>Occurs before the range content is pasted into target cells.
  1557. </para>
  1558. </summary>
  1559. </member>
  1560. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.CreateCommand(DevExpress.XtraSpreadsheet.Commands.SpreadsheetCommandId)">
  1561. <summary>
  1562. <para>Creates a command by its identifier.
  1563. </para>
  1564. </summary>
  1565. <param name="commandId">
  1566. A <b>DevExpress.XtraSpreadsheet.Commands.SpreadsheetCommandId</b> structure that identifies the command.
  1567. </param>
  1568. <returns>A <b>DevExpress.XtraSpreadsheet.Commands.SpreadsheetCommand</b> object that is the command used in a Spreadsheet UI.
  1569. </returns>
  1570. </member>
  1571. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.CreateNewDocument">
  1572. <summary>
  1573. <para>Creates and loads a new empty workbook.
  1574. </para>
  1575. </summary>
  1576. <returns><b>true</b>, if the document is created successfully; otherwise, <b>false</b>.
  1577. </returns>
  1578. </member>
  1579. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomAssemblyLoading">
  1580. <summary>
  1581. <para>Occurs before a custom assembly is loaded for use as the Entity Framework data source during mail merge and allows cancelling loading.
  1582. </para>
  1583. </summary>
  1584. </member>
  1585. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomCellEdit">
  1586. <summary>
  1587. <para>Allows you to assign a custom in-place editor to a cell.
  1588. </para>
  1589. </summary>
  1590. </member>
  1591. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawCell">
  1592. <summary>
  1593. <para>Provides the capability to perform custom painting of cell content.
  1594. </para>
  1595. </summary>
  1596. </member>
  1597. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawCellBackground">
  1598. <summary>
  1599. <para>Provides the capability to perform custom painting of the cell background.
  1600. </para>
  1601. </summary>
  1602. </member>
  1603. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeader">
  1604. <summary>
  1605. <para>Enables the column header to be painted manually.
  1606. </para>
  1607. </summary>
  1608. </member>
  1609. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawColumnHeaderBackground">
  1610. <summary>
  1611. <para>Enables the column header background to be painted manually.
  1612. </para>
  1613. </summary>
  1614. </member>
  1615. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawFrozenPaneBorder">
  1616. <summary>
  1617. <para>Enables frozen pane borders to be painted manually.
  1618. </para>
  1619. </summary>
  1620. </member>
  1621. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeader">
  1622. <summary>
  1623. <para>Enables the row header to be painted manually.
  1624. </para>
  1625. </summary>
  1626. </member>
  1627. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.CustomDrawRowHeaderBackground">
  1628. <summary>
  1629. <para>Enables the row header background to be painted manually.
  1630. </para>
  1631. </summary>
  1632. </member>
  1633. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DataBindingWarning">
  1634. <summary>
  1635. <para>Occurs before a data binding warning dialog is shown in the SpreadsheetControl.
  1636. </para>
  1637. </summary>
  1638. </member>
  1639. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DefinedNameConflictResolving">
  1640. <summary>
  1641. <para>Occurs when a formula or sheet being moved or copied contains a defined name which already exists on the destination worksheet or workbook.
  1642. </para>
  1643. </summary>
  1644. </member>
  1645. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DefinedNameDeleting">
  1646. <summary>
  1647. <para>Occurs before a Defined Name is deleted.
  1648. </para>
  1649. </summary>
  1650. </member>
  1651. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DefinedNameEditing">
  1652. <summary>
  1653. <para>Occurs before a Defined Name is being edited.
  1654. </para>
  1655. </summary>
  1656. </member>
  1657. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DefinedNameValidating">
  1658. <summary>
  1659. <para>Occurs when a new Defined Name is created before it is added to a collection.
  1660. </para>
  1661. </summary>
  1662. </member>
  1663. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Document">
  1664. <summary>
  1665. <para>Provides access to a workbook loaded in the control.
  1666. </para>
  1667. </summary>
  1668. <value>An object implementing the <see cref="T:DevExpress.Spreadsheet.IWorkbook"/> interface.
  1669. </value>
  1670. </member>
  1671. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DocumentClosing">
  1672. <summary>
  1673. <para>Occurs when a document that has not yet been saved is about to be closed.
  1674. </para>
  1675. </summary>
  1676. </member>
  1677. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DocumentLoaded">
  1678. <summary>
  1679. <para>Occurs after a document is loaded into the SpreadsheetControl.
  1680. </para>
  1681. </summary>
  1682. </member>
  1683. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.DocumentPropertiesChanged">
  1684. <summary>
  1685. <para>Occurs after one of the <see cref="T:DevExpress.Spreadsheet.DocumentProperties"/> is changed.
  1686. </para>
  1687. </summary>
  1688. </member>
  1689. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.DpiX">
  1690. <summary>
  1691. <para>Gets the current dpi value for the X-coordinate.
  1692. </para>
  1693. </summary>
  1694. <value>A <b>Single</b> dpi value.
  1695. </value>
  1696. </member>
  1697. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.DpiY">
  1698. <summary>
  1699. <para>Gets the current dpi value for the Y-coordinate.
  1700. </para>
  1701. </summary>
  1702. <value>A <b>Single</b> dpi value.
  1703. </value>
  1704. </member>
  1705. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.EmptyDocumentCreated">
  1706. <summary>
  1707. <para>Occurs when a new document is created in the SpreadsheetControl.
  1708. </para>
  1709. </summary>
  1710. </member>
  1711. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.EncryptedFileIntegrityCheckFailed">
  1712. <summary>
  1713. <para>Raises when the encrypted file did not pass the data integrity verification.
  1714. </para>
  1715. </summary>
  1716. </member>
  1717. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.EncryptedFilePasswordRequest">
  1718. <summary>
  1719. <para>Raises when the <see cref="P:DevExpress.XtraSpreadsheet.Import.WorkbookImportOptions.Password"/> property is not set or contains a wrong password.
  1720. </para>
  1721. </summary>
  1722. </member>
  1723. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.EndUpdate">
  1724. <summary>
  1725. <para>Unlocks the SpreadsheetControl object after a call to the <b>BeginUpdate</b> method and causes an immediate visual update.
  1726. </para>
  1727. </summary>
  1728. </member>
  1729. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.String,System.Int32)">
  1730. <summary>
  1731. <para>Exports the specified worksheet to the specified file in HTML format.
  1732. </para>
  1733. </summary>
  1734. <param name="fileName">
  1735. A <see cref="T:System.String"/> value which contains the full path (including the file name and extension) specifying where the HTML file will be created.
  1736. </param>
  1737. <param name="sheetIndex">
  1738. An integer value that is the index of the worksheet to be exported to HTML.
  1739. </param>
  1740. </member>
  1741. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.IO.Stream,DevExpress.Spreadsheet.Range)">
  1742. <summary>
  1743. <para>Exports the specified range to the specified stream in HTML format.
  1744. </para>
  1745. </summary>
  1746. <param name="stream">
  1747. A <see cref="T:System.IO.Stream"/> object to which the created HTML file should be sent.
  1748. </param>
  1749. <param name="range">
  1750. A <see cref="T:DevExpress.Spreadsheet.Range"/> object to be exported to HTML.
  1751. </param>
  1752. </member>
  1753. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.IO.Stream,DevExpress.Spreadsheet.Worksheet)">
  1754. <summary>
  1755. <para>Exports the specified worksheet to the specified stream in HTML format.
  1756. </para>
  1757. </summary>
  1758. <param name="stream">
  1759. A <see cref="T:System.IO.Stream"/> object to which the created HTML file should be sent.
  1760. </param>
  1761. <param name="sheet">
  1762. A <see cref="T:DevExpress.Spreadsheet.Worksheet"/> object to be exported to HTML.
  1763. </param>
  1764. </member>
  1765. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.IO.Stream,System.Int32)">
  1766. <summary>
  1767. <para>Exports the specified worksheet to the specified stream in HTML format.
  1768. </para>
  1769. </summary>
  1770. <param name="stream">
  1771. A <see cref="T:System.IO.Stream"/> object to which the created HTML file should be sent.
  1772. </param>
  1773. <param name="sheetIndex">
  1774. An integer value that is the index of the worksheet to be exported to HTML.
  1775. </param>
  1776. </member>
  1777. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.String,DevExpress.Spreadsheet.Range)">
  1778. <summary>
  1779. <para>Exports the specified range to the specified file in HTML format.
  1780. </para>
  1781. </summary>
  1782. <param name="fileName">
  1783. A <see cref="T:System.String"/> value which contains the full path (including the file name and extension) specifying where the HTML file will be created.
  1784. </param>
  1785. <param name="range">
  1786. A <see cref="T:DevExpress.Spreadsheet.Range"/> object to be exported to HTML.
  1787. </param>
  1788. </member>
  1789. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.String,DevExpress.Spreadsheet.Worksheet)">
  1790. <summary>
  1791. <para>Exports the specified worksheet to the specified file in HTML format.
  1792. </para>
  1793. </summary>
  1794. <param name="fileName">
  1795. A <see cref="T:System.String"/> value which contains the full path (including the file name and extension) specifying where the HTML file will be created.
  1796. </param>
  1797. <param name="sheet">
  1798. A <see cref="T:DevExpress.Spreadsheet.Worksheet"/> object to be exported to HTML.
  1799. </param>
  1800. </member>
  1801. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.String,DevExpress.XtraSpreadsheet.Export.HtmlDocumentExporterOptions)">
  1802. <summary>
  1803. <para>Exports the document's data to the specified file in HTML format using the specified options.
  1804. </para>
  1805. </summary>
  1806. <param name="fileName">
  1807. A <see cref="T:System.String"/> value which contains the full path (including the file name and extension) specifying where the HTML file will be created.
  1808. </param>
  1809. <param name="options">
  1810. A <see cref="T:DevExpress.XtraSpreadsheet.Export.HtmlDocumentExporterOptions"/> instance containing required export options.
  1811. </param>
  1812. </member>
  1813. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToHtml(System.IO.Stream,DevExpress.XtraSpreadsheet.Export.HtmlDocumentExporterOptions)">
  1814. <summary>
  1815. <para>Exports the document's data to the specified stream in HTML format using the specified options.
  1816. </para>
  1817. </summary>
  1818. <param name="stream">
  1819. A <see cref="T:System.IO.Stream"/> object to which the created HTML file should be sent.
  1820. </param>
  1821. <param name="options">
  1822. A <see cref="T:DevExpress.XtraSpreadsheet.Export.HtmlDocumentExporterOptions"/> instance containing required export options.
  1823. </param>
  1824. </member>
  1825. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToPdf(System.String,DevExpress.XtraPrinting.PdfExportOptions)">
  1826. <summary>
  1827. <para>Exports the content of the SpreadsheetControl to the specified file in PDF format using the specified options.
  1828. </para>
  1829. </summary>
  1830. <param name="fileName">
  1831. A <see cref="T:System.String"/> which specifies the name (including the full path) of the PDF file to which the data is exported.
  1832. </param>
  1833. <param name="pdfExportOptions">
  1834. A <see cref="T:DevExpress.XtraPrinting.PdfExportOptions"/> object which specifies the PDF export options.
  1835. </param>
  1836. </member>
  1837. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToPdf(System.IO.Stream)">
  1838. <summary>
  1839. <para>Exports the content of the SpreadsheetControl to the specified stream in PDF format.
  1840. </para>
  1841. </summary>
  1842. <param name="stream">
  1843. A <see cref="T:System.IO.Stream"/> object to which the created document is exported.
  1844. </param>
  1845. </member>
  1846. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToPdf(System.IO.Stream,DevExpress.XtraPrinting.PdfExportOptions)">
  1847. <summary>
  1848. <para>Exports the content of the SpreadsheetControl to the specified stream in PDF format using the specified options.
  1849. </para>
  1850. </summary>
  1851. <param name="stream">
  1852. A <see cref="T:System.IO.Stream"/> object, to which the created document is exported.
  1853. </param>
  1854. <param name="pdfExportOptions">
  1855. A <see cref="T:DevExpress.XtraPrinting.PdfExportOptions"/> object which specifies the PDF export options.
  1856. </param>
  1857. </member>
  1858. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ExportToPdf(System.String)">
  1859. <summary>
  1860. <para>Exports the content of the SpreadsheetControl to the specified file in PDF format.
  1861. </para>
  1862. </summary>
  1863. <param name="fileName">
  1864. A <see cref="T:System.String"/> which specifies the name (including the full path) of the PDF file to which the data is exported.
  1865. </param>
  1866. </member>
  1867. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Font">
  1868. <summary>
  1869. <para>This property is not supported by the SpreadsheetControl class.
  1870. </para>
  1871. </summary>
  1872. <value>
  1873. </value>
  1874. </member>
  1875. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ForeColor">
  1876. <summary>
  1877. <para>This property is not supported by the SpreadsheetControl class.
  1878. </para>
  1879. </summary>
  1880. <value>
  1881. </value>
  1882. </member>
  1883. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.GetCellBounds(System.Int32,System.Int32)">
  1884. <summary>
  1885. <para>Obtains the bounds of a cell specified by the row and column indices.
  1886. </para>
  1887. </summary>
  1888. <param name="rowIndex">
  1889. An integer that is the zero-based index of the row that contains the required cell.
  1890. </param>
  1891. <param name="columnIndex">
  1892. An integer that is the zero-based index of the column that contains the required cell.
  1893. </param>
  1894. <returns>A <see cref="T:System.Drawing.Rectangle"/> object that is the rectangle with the specified location and size.
  1895. </returns>
  1896. </member>
  1897. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.GetCellFromPoint(System.Drawing.PointF)">
  1898. <summary>
  1899. <para>Gets a worksheet cell located at the specified point.
  1900. </para>
  1901. </summary>
  1902. <param name="clientPoint">
  1903. A <see cref="T:System.Drawing.PointF"/> structure specifying the location for which the position is retrieved. The point coordinates are measured in documents units.
  1904. </param>
  1905. <returns>A <see cref="T:DevExpress.Spreadsheet.Cell"/> object.
  1906. </returns>
  1907. </member>
  1908. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.GetSelectedRanges">
  1909. <summary>
  1910. <para>Returns cell ranges currently selected in the active worksheet.
  1911. </para>
  1912. </summary>
  1913. <returns>A list of the <see cref="T:DevExpress.Spreadsheet.Range"/> objects.
  1914. </returns>
  1915. </member>
  1916. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.GetSelectedShapes">
  1917. <summary>
  1918. <para>Returns shapes currently selected in the active worksheet.
  1919. </para>
  1920. </summary>
  1921. <returns>A list of the <see cref="T:DevExpress.Spreadsheet.Shape"/> objects.
  1922. </returns>
  1923. </member>
  1924. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.GetService(System.Type)">
  1925. <summary>
  1926. <para>Gets the service object of the specified type.
  1927. </para>
  1928. </summary>
  1929. <param name="serviceType">
  1930. An object that specifies the type of service object to get.
  1931. </param>
  1932. <returns>A service object of the specified type, or a null reference (Nothing in Visual Basic) if there is no service object of this type.
  1933. </returns>
  1934. </member>
  1935. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.GetService``1">
  1936. <summary>
  1937. <para>Gets the specified service.
  1938. </para>
  1939. </summary>
  1940. <returns>A service object of the specified type or null for reference types and zero for numeric value types if a service is not available.
  1941. </returns>
  1942. </member>
  1943. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.HyperlinkClick">
  1944. <summary>
  1945. <para>Occurs when an end-user activates the hyperlink before navigating to the referenced location.
  1946. </para>
  1947. </summary>
  1948. </member>
  1949. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.InitializeDocument">
  1950. <summary>
  1951. <para>Occurs before a document is loaded. Handle this event to set the initial document settings.
  1952. </para>
  1953. </summary>
  1954. </member>
  1955. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.InvalidFormatException">
  1956. <summary>
  1957. <para>Fires when the supplied data could not be recognized as data in the assumed format for import.
  1958. </para>
  1959. </summary>
  1960. </member>
  1961. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.IsCellEditorActive">
  1962. <summary>
  1963. <para>Gets whether the cell editor is currently active.
  1964. </para>
  1965. </summary>
  1966. <value><b>true</b>, if the cell editor is opened; otherwise, <b>false</b>.
  1967. </value>
  1968. </member>
  1969. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.IsPrintingAvailable">
  1970. <summary>
  1971. <para>Indicates whether the SpreadsheetControl can be printed or exported.
  1972. </para>
  1973. </summary>
  1974. <value><b>true</b>, if the control can be printed and exported; otherwise, <b>false</b>.
  1975. </value>
  1976. </member>
  1977. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.IsPrintPreviewAvailable">
  1978. <summary>
  1979. <para>Gets a value indicating whether a preview of the SpreadsheetControl's document is allowed.
  1980. </para>
  1981. </summary>
  1982. <value><b>true</b>, if the print preview is available; otherwise, <b>false</b>.
  1983. </value>
  1984. </member>
  1985. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.IsUpdateLocked">
  1986. <summary>
  1987. <para>Gets whether the control has been locked for updating.
  1988. </para>
  1989. </summary>
  1990. <value><b>true</b>, if the control is locked; otherwise, <b>false</b>.
  1991. </value>
  1992. </member>
  1993. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.LayoutUnit">
  1994. <summary>
  1995. <para>Gets or sets a unit of measure used for a document layout.
  1996. </para>
  1997. </summary>
  1998. <value>The <see cref="T:DevExpress.Office.DocumentLayoutUnit"/> enumeration value.
  1999. </value>
  2000. </member>
  2001. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument(System.String)">
  2002. <summary>
  2003. <para>Loads a document from a file. The document format is identified by the file extension.
  2004. </para>
  2005. </summary>
  2006. <param name="fileName">
  2007. A string specifying the file to load (including the full path).
  2008. </param>
  2009. <returns><b>true</b>, if a document is loaded successfully; otherwise, <b>false</b>.
  2010. </returns>
  2011. </member>
  2012. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument(System.String,DevExpress.Spreadsheet.DocumentFormat)">
  2013. <summary>
  2014. <para>Loads a document from a file, specifying the document format.
  2015. </para>
  2016. </summary>
  2017. <param name="fileName">
  2018. A string specifying the file to load (including the full path).
  2019. </param>
  2020. <param name="format">
  2021. One of the <see cref="T:DevExpress.Spreadsheet.DocumentFormat"/> members.
  2022. </param>
  2023. <returns><b>true</b>, if a document is loaded successfully; otherwise, <b>false</b>.
  2024. </returns>
  2025. </member>
  2026. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument(System.IO.Stream,DevExpress.Spreadsheet.DocumentFormat)">
  2027. <summary>
  2028. <para>Loads a document from a stream, specifying the document format.
  2029. </para>
  2030. </summary>
  2031. <param name="stream">
  2032. The stream from which to load a document.
  2033. </param>
  2034. <param name="format">
  2035. One of the <see cref="T:DevExpress.Spreadsheet.DocumentFormat"/> members.
  2036. </param>
  2037. <returns><b>true</b>, if a document is loaded successfully; otherwise, <b>false</b>.
  2038. </returns>
  2039. </member>
  2040. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument(System.Byte[],DevExpress.Spreadsheet.DocumentFormat)">
  2041. <summary>
  2042. <para>Loads a document from a byte array.
  2043. </para>
  2044. </summary>
  2045. <param name="buffer">
  2046. A <see cref="T:System.Byte[]"/> object that is an array of bytes containing document data in the specified format.
  2047. </param>
  2048. <param name="format">
  2049. A <see cref="T:DevExpress.Spreadsheet.DocumentFormat"/> enumeration member specifying the format of the document to be loaded.
  2050. </param>
  2051. <returns><b>true</b>, if the document is successfully loaded; otherwise, <b>false</b>.
  2052. </returns>
  2053. </member>
  2054. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument">
  2055. <summary>
  2056. <para>Invokes the <b>Open</b> dialog, creates a specific importer and loads the file.
  2057. </para>
  2058. </summary>
  2059. </member>
  2060. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument(System.Windows.Forms.IWin32Window)">
  2061. <summary>
  2062. <para>Invokes the <b>Open</b> file dialog as a child of the specified parent window.
  2063. </para>
  2064. </summary>
  2065. <param name="parent">
  2066. The <see cref="T:System.Windows.Forms.IWin32Window"/> that is the parent window.
  2067. </param>
  2068. </member>
  2069. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument(System.IO.Stream)">
  2070. <summary>
  2071. <para>Loads the document from a stream.
  2072. </para>
  2073. </summary>
  2074. <param name="stream">
  2075. A <see cref="T:System.IO.Stream"/> object that is the stream used to load a document.
  2076. </param>
  2077. <returns><b>true</b>, if the document is loaded succesfully; otherwise, <b>false</b>.
  2078. </returns>
  2079. </member>
  2080. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.LoadDocument(System.Byte[])">
  2081. <summary>
  2082. <para>Load the document from a <see cref="T:System.Byte[]"/> array.
  2083. </para>
  2084. </summary>
  2085. <param name="buffer">
  2086. A System.Byte[] object that is an array of bytes containing document data.
  2087. </param>
  2088. <returns><b>true</b>, if the document is loaded succesfully; otherwise, <b>false</b>.
  2089. </returns>
  2090. </member>
  2091. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.LookAndFeel">
  2092. <summary>
  2093. <para>Provides access to the control's look and feel settings.
  2094. </para>
  2095. </summary>
  2096. <value>A <see cref="T:DevExpress.LookAndFeel.UserLookAndFeel"/> object whose properties specify the control's look and feel.
  2097. </value>
  2098. </member>
  2099. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.MenuManager">
  2100. <summary>
  2101. <para>Gets or sets the menu manager which controls the look and feel of context menus.
  2102. </para>
  2103. </summary>
  2104. <value>An object that implements the <see cref="T:DevExpress.Utils.Menu.IDXMenuManager"/> interface.
  2105. </value>
  2106. </member>
  2107. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Modified">
  2108. <summary>
  2109. <para>Gets or sets a value that indicates that the document content was modified since it was last saved.
  2110. </para>
  2111. </summary>
  2112. <value><b>true</b>, if the control's content was modified since it was last saved; otherwise, <b>false</b>.
  2113. </value>
  2114. </member>
  2115. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ModifiedChanged">
  2116. <summary>
  2117. <para>Occurs when the value of the <see cref="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Modified"/> property is changed.
  2118. </para>
  2119. </summary>
  2120. </member>
  2121. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.OpenCellEditor(DevExpress.XtraSpreadsheet.CellEditorMode)">
  2122. <summary>
  2123. <para>Invokes a cell editor and switches to the spreadsheet edit mode, allowing you to edit cell content.
  2124. </para>
  2125. </summary>
  2126. <param name="mode">
  2127. A <see cref="T:DevExpress.XtraSpreadsheet.CellEditorMode"/> that specifies the editor and the mode in which it is activated.
  2128. </param>
  2129. <returns><b>true</b>, if the cell editor is active; otherwise, <b>false</b>.
  2130. </returns>
  2131. </member>
  2132. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Options">
  2133. <summary>
  2134. <para>Provides access to the variety of options which can be specified for the document loaded into the SpreadsheetControl and the control itself.
  2135. </para>
  2136. </summary>
  2137. <value>A <see cref="T:DevExpress.XtraSpreadsheet.SpreadsheetControlOptions"/> object.
  2138. </value>
  2139. </member>
  2140. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.PanesFrozen">
  2141. <summary>
  2142. <para>Occurs after a worksheet area has been frozen via the SpreadsheetControl's UI.
  2143. </para>
  2144. </summary>
  2145. </member>
  2146. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.PanesUnfrozen">
  2147. <summary>
  2148. <para>Occurs after a frozen worksheet area has been unlocked via the SpreadsheetControl's UI.
  2149. </para>
  2150. </summary>
  2151. </member>
  2152. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.PopupMenuShowing">
  2153. <summary>
  2154. <para>Occurs when a popup menu is about to be displayed for the SpreadsheetControl's visual elements.
  2155. </para>
  2156. </summary>
  2157. </member>
  2158. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.Print">
  2159. <summary>
  2160. <para>Prints the document to the default printer.
  2161. </para>
  2162. </summary>
  2163. </member>
  2164. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.PropertyChanged">
  2165. <summary>
  2166. <para>Occurs every time any of the SpreadsheetControl class properties has changed its value.
  2167. </para>
  2168. </summary>
  2169. </member>
  2170. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ProtectionWarning">
  2171. <summary>
  2172. <para>Occurs when attempting to edit a locked cell in a protected worksheet.
  2173. </para>
  2174. </summary>
  2175. </member>
  2176. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.RangeCopied">
  2177. <summary>
  2178. <para>Occurs after the range content has been copied.
  2179. </para>
  2180. </summary>
  2181. </member>
  2182. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.RangeCopying">
  2183. <summary>
  2184. <para>Occurs before a cell range is copied in a worksheet.
  2185. </para>
  2186. </summary>
  2187. </member>
  2188. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ReadOnly">
  2189. <summary>
  2190. <para>Gets or sets whether document modifications are prohibited.
  2191. </para>
  2192. </summary>
  2193. <value><b>true</b>, if the document is in a read-only state; otherwise, <b>false</b>.
  2194. </value>
  2195. </member>
  2196. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ReadOnlyChanged">
  2197. <summary>
  2198. <para>Occurs when the SpreadsheetControl's read-only state is changed.
  2199. </para>
  2200. </summary>
  2201. </member>
  2202. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.RemoveService(System.Type)">
  2203. <summary>
  2204. <para>Removes the service of the specified type from the service container.
  2205. </para>
  2206. </summary>
  2207. <param name="serviceType">
  2208. The type of service to remove.
  2209. </param>
  2210. </member>
  2211. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.RemoveService(System.Type,System.Boolean)">
  2212. <summary>
  2213. <para>Removes the service of the specified type from the service container.
  2214. </para>
  2215. </summary>
  2216. <param name="serviceType">
  2217. The type of service to remove.
  2218. </param>
  2219. <param name="promote">
  2220. <b>true</b>, to promote this request to any parent service containers; <b>otherwise</b>, false.
  2221. </param>
  2222. </member>
  2223. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.RemoveShortcutKey(System.Windows.Forms.Keys,System.Windows.Forms.Keys)">
  2224. <summary>
  2225. <para>Removes a command shortcut.
  2226. </para>
  2227. </summary>
  2228. <param name="key">
  2229. A System.Windows.Forms.Keys enumeration member specifying a shortcut key.
  2230. </param>
  2231. <param name="modifier">
  2232. A System.Windows.Forms.Keys enumeration member specifying a modifier key.
  2233. </param>
  2234. </member>
  2235. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ReplaceService``1(``0)">
  2236. <summary>
  2237. <para>Performs a service substitution.
  2238. </para>
  2239. </summary>
  2240. <param name="newService">
  2241. A service of the specified type that will be registered.
  2242. </param>
  2243. <returns>Previously registered service of the specified type, or null (<b>Nothing</b> in Visual Basic) if the service does not exist.
  2244. </returns>
  2245. </member>
  2246. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ResetLayout">
  2247. <summary>
  2248. <para>Updates the layout of the document loaded into control and the control itself.
  2249. </para>
  2250. </summary>
  2251. </member>
  2252. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.RightToLeft">
  2253. <summary>
  2254. <para>This property is not in effect for the SpreadsheetControl class.
  2255. </para>
  2256. </summary>
  2257. <value>
  2258. </value>
  2259. </member>
  2260. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.RowsInserted">
  2261. <summary>
  2262. <para>Occurs after new rows have been added to a worksheet via the SpreadsheetControl's UI.
  2263. </para>
  2264. </summary>
  2265. </member>
  2266. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.RowsInserting">
  2267. <summary>
  2268. <para>Occurs when new rows are about to be inserted into a worksheet.
  2269. </para>
  2270. </summary>
  2271. </member>
  2272. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.RowsRemoved">
  2273. <summary>
  2274. <para>Occurs after rows have been deleted from a worksheet via the SpreadsheetControl's UI.
  2275. </para>
  2276. </summary>
  2277. </member>
  2278. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.RowsRemoving">
  2279. <summary>
  2280. <para>Occurs when rows are about to be deleted from a worksheet.
  2281. </para>
  2282. </summary>
  2283. </member>
  2284. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocument(System.String,DevExpress.Spreadsheet.DocumentFormat)">
  2285. <summary>
  2286. <para>Saves the control's document to a file, specifying the document format.
  2287. </para>
  2288. </summary>
  2289. <param name="fileName">
  2290. A string value specifying the path to a file in which to save the control's document.
  2291. </param>
  2292. <param name="format">
  2293. One of the <see cref="T:DevExpress.Spreadsheet.DocumentFormat"/> enumeration values.
  2294. </param>
  2295. </member>
  2296. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocument(System.String)">
  2297. <summary>
  2298. <para>Saves the document to the specified file. The file format is identified by the file extension.
  2299. </para>
  2300. </summary>
  2301. <param name="fileName">
  2302. A string value specifying the path to a file in which to save the document.
  2303. </param>
  2304. </member>
  2305. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocument(System.IO.Stream,DevExpress.Spreadsheet.DocumentFormat)">
  2306. <summary>
  2307. <para>Saves the workbook to a stream, specifying the export format.
  2308. </para>
  2309. </summary>
  2310. <param name="stream">
  2311. The <see cref="T:System.IO.Stream"/> object to output the document to.
  2312. </param>
  2313. <param name="format">
  2314. One of the <see cref="T:DevExpress.Spreadsheet.DocumentFormat"/> values that is the format of the exported document.
  2315. </param>
  2316. </member>
  2317. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocument(DevExpress.Spreadsheet.DocumentFormat)">
  2318. <summary>
  2319. <para>Saves a document to an array of bytes in the specified format.
  2320. </para>
  2321. </summary>
  2322. <param name="format">
  2323. A <see cref="T:DevExpress.Spreadsheet.DocumentFormat"/> enumeration member specifying the format of the document to be saved.
  2324. </param>
  2325. <returns>A <see cref="T:System.Byte[]"/> object that is an array of bytes containing document data in the specified format.
  2326. </returns>
  2327. </member>
  2328. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocument">
  2329. <summary>
  2330. <para>Saves a document in its original format to its original location.
  2331. </para>
  2332. </summary>
  2333. <returns><b>true</b>, if a document has been successfully saved; otherwise, <b>false</b>.
  2334. </returns>
  2335. </member>
  2336. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocument(System.Windows.Forms.IWin32Window)">
  2337. <summary>
  2338. <para>Saves a document in its original format to its original location. If original format and location are not specified, invokes the <b>Save As</b> dialog that is shown modally as a child of the specified parent window.
  2339. </para>
  2340. </summary>
  2341. <param name="parent">
  2342. The <see cref="T:System.Windows.Forms.IWin32Window"/> that is the parent window.
  2343. </param>
  2344. <returns><b>true</b>, if a document has been successfully saved; otherwise, <b>false</b>.
  2345. </returns>
  2346. </member>
  2347. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocumentAs(System.Windows.Forms.IWin32Window)">
  2348. <summary>
  2349. <para>Invokes the <b>Save As</b> dialog which is shown modally as a child of the specified parent window.
  2350. </para>
  2351. </summary>
  2352. <param name="parent">
  2353. The <see cref="T:System.Windows.Forms.IWin32Window"/> that is the parent window.
  2354. </param>
  2355. </member>
  2356. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SaveDocumentAs">
  2357. <summary>
  2358. <para>Invokes the <b>Save As</b> dialog and saves a document.
  2359. </para>
  2360. </summary>
  2361. </member>
  2362. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ScrollPositionChanged">
  2363. <summary>
  2364. <para>Occurs when a worksheet is being scrolled in the SpreadsheetControl's UI.
  2365. </para>
  2366. </summary>
  2367. </member>
  2368. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.SelectedCell">
  2369. <summary>
  2370. <para>Gets or sets an active cell in the active worksheet.
  2371. </para>
  2372. </summary>
  2373. <value>A <see cref="T:DevExpress.Spreadsheet.Range"/> object specifying an active cell in a worksheet that is currently active. If you assign a cell located in a worksheet that is not active, an exception is raised.
  2374. </value>
  2375. </member>
  2376. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.SelectedComment">
  2377. <summary>
  2378. <para>Gets or sets a comment selected in the active worksheet.
  2379. </para>
  2380. </summary>
  2381. <value>A <see cref="T:DevExpress.Spreadsheet.Comment"/> object, or <b>null</b> (<b>Nothing</b> in VB) if a comment is not selected.
  2382. </value>
  2383. </member>
  2384. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.SelectedPicture">
  2385. <summary>
  2386. <para>Gets or sets a picture selected in the active worksheet.
  2387. </para>
  2388. </summary>
  2389. <value>A <see cref="T:DevExpress.Spreadsheet.Picture"/> object. If you assign a picture located in a worksheet that is not active, an exception is raised.
  2390. </value>
  2391. </member>
  2392. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.SelectedShape">
  2393. <summary>
  2394. <para>Gets or sets a shape selected in the active worksheet.
  2395. </para>
  2396. </summary>
  2397. <value>A <see cref="T:DevExpress.Spreadsheet.Shape"/> object. If you assign a shape located in a worksheet that is not active, an exception is raised.
  2398. </value>
  2399. </member>
  2400. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Selection">
  2401. <summary>
  2402. <para>Gets or sets a cell range selected in the active worksheet.
  2403. </para>
  2404. </summary>
  2405. <value>A <see cref="T:DevExpress.Spreadsheet.Range"/> object specifying the cell selection in a worksheet that is currently active. If you assign a cell range located in a worksheet that is not active, an exception is raised.
  2406. </value>
  2407. </member>
  2408. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.SelectionChanged">
  2409. <summary>
  2410. <para>Fires in response to changing cell selection in an active worksheet.
  2411. </para>
  2412. </summary>
  2413. </member>
  2414. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SetSelectedRanges(System.Collections.Generic.IList`1)">
  2415. <summary>
  2416. <para>Sets cell ranges selected in the active worksheet.
  2417. </para>
  2418. </summary>
  2419. <param name="ranges">
  2420. A list of the <see cref="T:DevExpress.Spreadsheet.Range"/> objects.
  2421. </param>
  2422. <returns><b>true</b> if cell ranges are selected successfully; otherwise <b>false</b>. If you pass <b>null</b> (<b>Nothing</b> in Visual Basic), or an empty list, or a list that contains at least one cell range located in a worksheet other than the current worksheet, the method returns <b>false</b>.
  2423. </returns>
  2424. </member>
  2425. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SetSelectedRanges(System.Collections.Generic.IList`1,System.Boolean)">
  2426. <summary>
  2427. <para>Selects cell ranges in the worksheet and specifies whether the selection expands to fit merged cells.
  2428. </para>
  2429. </summary>
  2430. <param name="ranges">
  2431. A list of the <see cref="T:DevExpress.Spreadsheet.Range"/> objects.
  2432. </param>
  2433. <param name="expandToMergedCellsSize">
  2434. <b>true</b>, to expand the selection to include merged cells; otherwise, <b>false</b>.
  2435. </param>
  2436. <returns><b>true</b>, if cell ranges are selected successfully; otherwise <b>false</b>.
  2437. </returns>
  2438. </member>
  2439. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.SetSelectedShapes(System.Collections.Generic.IList`1)">
  2440. <summary>
  2441. <para>Sets shapes selected in the active worksheet.
  2442. </para>
  2443. </summary>
  2444. <param name="Shapes">
  2445. A list of the <see cref="T:DevExpress.Spreadsheet.Shape"/> objects.
  2446. </param>
  2447. <returns><b>true</b> if shapes are selected successfully; otherwise <b>false</b>. If you pass a list that contains at least one shape located in a worksheet that is not active, the method returns <b>false</b>.
  2448. </returns>
  2449. </member>
  2450. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ShapeInserted">
  2451. <summary>
  2452. <para>Occurs after a shape has been inserted into a worksheet.
  2453. </para>
  2454. </summary>
  2455. </member>
  2456. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ShapeRemoved">
  2457. <summary>
  2458. <para>Occurs after a shape has been removed from a worksheet.
  2459. </para>
  2460. </summary>
  2461. </member>
  2462. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ShapeRemoving">
  2463. <summary>
  2464. <para>Occurs before a shape is removed from a worksheet.
  2465. </para>
  2466. </summary>
  2467. </member>
  2468. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ShapesCopying">
  2469. <summary>
  2470. <para>Occurs before a shape is copied.
  2471. </para>
  2472. </summary>
  2473. </member>
  2474. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.SheetInserted">
  2475. <summary>
  2476. <para>Occurs after a new worksheet has been added into a workbook via the SpreadsheetControl's UI.
  2477. </para>
  2478. </summary>
  2479. </member>
  2480. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.SheetRemoved">
  2481. <summary>
  2482. <para>Occurs after a worksheet has been removed from a workbook via the SpreadsheetControl's UI.
  2483. </para>
  2484. </summary>
  2485. </member>
  2486. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.SheetRemoving">
  2487. <summary>
  2488. <para>Occurs when a worksheet is about to be removed from a workbook.
  2489. </para>
  2490. </summary>
  2491. </member>
  2492. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.SheetRenamed">
  2493. <summary>
  2494. <para>Occurs after a worksheet has been renamed via the SpreadsheetControl's UI.
  2495. </para>
  2496. </summary>
  2497. </member>
  2498. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.SheetRenaming">
  2499. <summary>
  2500. <para>Occurs when a worksheet is about to be renamed via the SpreadsheetControl's UI.
  2501. </para>
  2502. </summary>
  2503. </member>
  2504. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ShowPrintDialog">
  2505. <summary>
  2506. <para>Invokes the <b>Print</b> dialog to select a printer, specify the print options (number of copies, page range, and paper source) and print the document.
  2507. </para>
  2508. </summary>
  2509. </member>
  2510. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ShowPrintPreview">
  2511. <summary>
  2512. <para>Invokes the <b>Print Preview</b> window with a Bar UI.
  2513. </para>
  2514. </summary>
  2515. </member>
  2516. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.ShowRibbonPrintPreview">
  2517. <summary>
  2518. <para>Invokes the <b>Print Preview</b> window with a Ribbon UI.
  2519. </para>
  2520. </summary>
  2521. </member>
  2522. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.ToolTipController">
  2523. <summary>
  2524. <para>Gets or sets the tooltip controller component that controls the appearance, position and the content of the hints displayed by the SpreadsheetControl.
  2525. </para>
  2526. </summary>
  2527. <value>A <see cref="T:DevExpress.Utils.ToolTipController"/> component which controls the appearance and behavior of the hints displayed by the SpreadsheetControl.
  2528. </value>
  2529. </member>
  2530. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.UnhandledException">
  2531. <summary>
  2532. <para>This event is raised when an exception, unhandled by the SpreadsheetControl, occurs.
  2533. </para>
  2534. </summary>
  2535. </member>
  2536. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.Unit">
  2537. <summary>
  2538. <para>Gets or sets a unit of measure used in the workbook.
  2539. </para>
  2540. </summary>
  2541. <value>The <see cref="T:DevExpress.Office.DocumentUnit"/> enumeration member.
  2542. </value>
  2543. </member>
  2544. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.UnitChanged">
  2545. <summary>
  2546. <para>Fires after a unit of measurement used in the workbook is changed.
  2547. </para>
  2548. </summary>
  2549. </member>
  2550. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.UnitChanging">
  2551. <summary>
  2552. <para>Fires before a unit of measurement used within the workbook is changed.
  2553. </para>
  2554. </summary>
  2555. </member>
  2556. <member name="M:DevExpress.XtraSpreadsheet.SpreadsheetControl.UpdateCommandUI">
  2557. <summary>
  2558. <para>Refreshes the SpreadsheetControl command UI.
  2559. </para>
  2560. </summary>
  2561. </member>
  2562. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.UpdateUI">
  2563. <summary>
  2564. <para>Raised when changes occur which may affect the control's UI.
  2565. </para>
  2566. </summary>
  2567. </member>
  2568. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ValidateCustomSqlQuery">
  2569. <summary>
  2570. <para>Allows validation of the custom SQL query created using the Data Source Wizard.
  2571. </para>
  2572. </summary>
  2573. </member>
  2574. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.VisibleRange">
  2575. <summary>
  2576. <para>Gets the cell range that is currently visible in the SpreadsheetControl.
  2577. </para>
  2578. </summary>
  2579. <value>A <see cref="T:DevExpress.Spreadsheet.Range"/> object specifying the current visible range of cells.
  2580. </value>
  2581. </member>
  2582. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.VisibleUnfrozenRange">
  2583. <summary>
  2584. <para>Gets the visible cell range of the scrollable area when there are frozen rows and columns in the worksheet.
  2585. </para>
  2586. </summary>
  2587. <value>A <see cref="T:DevExpress.Spreadsheet.Range"/> object.
  2588. </value>
  2589. </member>
  2590. <member name="P:DevExpress.XtraSpreadsheet.SpreadsheetControl.WorksheetDisplayArea">
  2591. <summary>
  2592. <para>Provides access to an object enabling you to specify a worksheet area that is visible in the SpreadsheetControl and allows end-user input.
  2593. </para>
  2594. </summary>
  2595. <value>A <see cref="T:DevExpress.XtraSpreadsheet.WorksheetDisplayArea"/> object.
  2596. </value>
  2597. </member>
  2598. <member name="E:DevExpress.XtraSpreadsheet.SpreadsheetControl.ZoomChanged">
  2599. <summary>
  2600. <para>Occurs when the current zoom level of the active worksheet has been changed via the SpreadsheetControl's UI.
  2601. </para>
  2602. </summary>
  2603. </member>
  2604. </members>
  2605. </doc>