ExcelMapper.xml 43 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ExcelMapper</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Ganss.Excel.ColumnAttribute">
  8. <summary>
  9. Attribute that specifies the mapping of a property to a column in an Excel file.
  10. </summary>
  11. <seealso cref="T:System.Attribute" />
  12. </member>
  13. <member name="M:Ganss.Excel.ColumnAttribute.#ctor(System.String)">
  14. <summary>
  15. Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
  16. </summary>
  17. <param name="name">The name of the column.</param>
  18. </member>
  19. <member name="M:Ganss.Excel.ColumnAttribute.#ctor(System.Int32)">
  20. <summary>
  21. Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
  22. </summary>
  23. <param name="index">The index of the column.</param>
  24. </member>
  25. <member name="P:Ganss.Excel.ColumnAttribute.Name">
  26. <summary>
  27. Gets the name of the column.
  28. </summary>
  29. <value>
  30. The name of the column.
  31. </value>
  32. </member>
  33. <member name="P:Ganss.Excel.ColumnAttribute.Index">
  34. <summary>
  35. Gets the index of the column.
  36. </summary>
  37. <value>
  38. The index of the column.
  39. </value>
  40. </member>
  41. <member name="T:Ganss.Excel.DataFormatAttribute">
  42. <summary>
  43. Attribute that specifies the data format of an Excel cell.
  44. The format can either be a <a href="https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html">builtin format</a>
  45. or a <a href="https://support.office.com/en-nz/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4">custom format string</a>.
  46. </summary>
  47. <seealso cref="T:System.Attribute" />
  48. </member>
  49. <member name="P:Ganss.Excel.DataFormatAttribute.BuiltinFormat">
  50. <summary>
  51. Gets or sets the builtin format, see https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html for possible values.
  52. </summary>
  53. <value>
  54. The builtin format.
  55. </value>
  56. </member>
  57. <member name="P:Ganss.Excel.DataFormatAttribute.CustomFormat">
  58. <summary>
  59. Gets or sets the custom format, see https://support.office.com/en-nz/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4 for the syntax.
  60. </summary>
  61. <value>
  62. The custom format.
  63. </value>
  64. </member>
  65. <member name="M:Ganss.Excel.DataFormatAttribute.#ctor(System.Int16)">
  66. <summary>
  67. Initializes a new instance of the <see cref="T:Ganss.Excel.DataFormatAttribute"/> class.
  68. </summary>
  69. <param name="format">The format, see https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html for possible values.</param>
  70. </member>
  71. <member name="M:Ganss.Excel.DataFormatAttribute.#ctor(System.String)">
  72. <summary>
  73. Initializes a new instance of the <see cref="T:Ganss.Excel.DataFormatAttribute"/> class.
  74. </summary>
  75. <param name="format">The format, see https://support.office.com/en-nz/article/Create-or-delete-a-custom-number-format-78f2a361-936b-4c03-8772-09fab54be7f4 for the syntax.</param>
  76. </member>
  77. <member name="T:Ganss.Excel.ExcelMapper">
  78. <summary>
  79. Map objects to Excel files.
  80. </summary>
  81. </member>
  82. <member name="P:Ganss.Excel.ExcelMapper.TypeMapperFactory">
  83. <summary>
  84. Gets or sets the <see cref="T:Ganss.Excel.TypeMapper"/> factory.
  85. Default is a static <see cref="T:Ganss.Excel.TypeMapperFactory"/> object that caches <see cref="T:Ganss.Excel.TypeMapper"/>s statically across <see cref="T:Ganss.Excel.ExcelMapper"/> instances.
  86. </summary>
  87. <value>
  88. The <see cref="T:Ganss.Excel.TypeMapper"/> factory.
  89. </value>
  90. </member>
  91. <member name="P:Ganss.Excel.ExcelMapper.HeaderRow">
  92. <summary>
  93. Gets or sets a value indicating whether the Excel file contains a header row of column names. Default is <c>true</c>.
  94. </summary>
  95. <value>
  96. <c>true</c> if the Excel file contains a header row; otherwise, <c>false</c>.
  97. </value>
  98. </member>
  99. <member name="P:Ganss.Excel.ExcelMapper.HeaderRowNumber">
  100. <summary>
  101. Gets or sets the row number of the header row. Default is 0.
  102. The header row may be outside of the range of <see cref="P:Ganss.Excel.ExcelMapper.MinRowNumber"/> and <see cref="P:Ganss.Excel.ExcelMapper.MaxRowNumber"/>.
  103. </summary>
  104. <value>
  105. The header row number.
  106. </value>
  107. </member>
  108. <member name="P:Ganss.Excel.ExcelMapper.MinRowNumber">
  109. <summary>
  110. Gets or sets the minimum row number of the rows that may contain data. Default is 0.
  111. </summary>
  112. <value>
  113. The minimum row number.
  114. </value>
  115. </member>
  116. <member name="P:Ganss.Excel.ExcelMapper.MaxRowNumber">
  117. <summary>
  118. Gets or sets the inclusive maximum row number of the rows that may contain data. Default is <see cref="F:System.Int32.MaxValue"/>.
  119. </summary>
  120. <value>
  121. The maximum row number.
  122. </value>
  123. </member>
  124. <member name="P:Ganss.Excel.ExcelMapper.TrackObjects">
  125. <summary>
  126. Gets or sets a value indicating whether to track objects read from the Excel file. Default is true.
  127. If object tracking is enabled, the <see cref="T:Ganss.Excel.ExcelMapper"/> object keeps track of objects it yields through the Fetch() methods.
  128. You can then modify these objects and save them back to an Excel file without having to specify the list of objects to save.
  129. </summary>
  130. <value>
  131. <c>true</c> if object tracking is enabled; otherwise, <c>false</c>.
  132. </value>
  133. </member>
  134. <member name="P:Ganss.Excel.ExcelMapper.SkipBlankRows">
  135. <summary>
  136. Gets or sets a value indicating whether to skip blank rows when reading from Excel files. Default is true.
  137. </summary>
  138. <value>
  139. <c>true</c> if blank lines are skipped; otherwise, <c>false</c>.
  140. </value>
  141. </member>
  142. <member name="M:Ganss.Excel.ExcelMapper.#ctor">
  143. <summary>
  144. Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
  145. </summary>
  146. </member>
  147. <member name="M:Ganss.Excel.ExcelMapper.#ctor(NPOI.SS.UserModel.IWorkbook)">
  148. <summary>
  149. Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
  150. </summary>
  151. <param name="workbook">The workbook.</param>
  152. </member>
  153. <member name="M:Ganss.Excel.ExcelMapper.#ctor(System.String)">
  154. <summary>
  155. Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
  156. </summary>
  157. <param name="file">The path to the Excel file.</param>
  158. </member>
  159. <member name="M:Ganss.Excel.ExcelMapper.#ctor(System.IO.Stream)">
  160. <summary>
  161. Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
  162. </summary>
  163. <param name="stream">The stream the Excel file is read from.</param>
  164. </member>
  165. <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String,System.String)">
  166. <summary>
  167. Fetches objects from the specified sheet name.
  168. </summary>
  169. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  170. <param name="file">The path to the Excel file.</param>
  171. <param name="sheetName">Name of the sheet.</param>
  172. <returns>The objects read from the Excel file.</returns>
  173. </member>
  174. <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.Type,System.String)">
  175. <summary>
  176. Fetches objects from the specified sheet name.
  177. </summary>
  178. <param name="type">The type of objects the Excel file is mapped to.</param>
  179. <param name="file">The path to the Excel file.</param>
  180. <param name="sheetName">Name of the sheet.</param>
  181. <returns>The objects read from the Excel file.</returns>
  182. </member>
  183. <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String,System.Int32)">
  184. <summary>
  185. Fetches objects from the specified sheet index.
  186. </summary>
  187. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  188. <param name="file">The path to the Excel file.</param>
  189. <param name="sheetIndex">Index of the sheet.</param>
  190. <returns>The objects read from the Excel file.</returns>
  191. </member>
  192. <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.Type,System.Int32)">
  193. <summary>
  194. Fetches objects from the specified sheet index.
  195. </summary>
  196. <param name="type">The type of objects the Excel file is mapped to.</param>
  197. <param name="file">The path to the Excel file.</param>
  198. <param name="sheetIndex">Index of the sheet.</param>
  199. <returns>The objects read from the Excel file.</returns>
  200. </member>
  201. <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.IO.Stream,System.String)">
  202. <summary>
  203. Fetches objects from the specified sheet name.
  204. </summary>
  205. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  206. <param name="stream">The stream the Excel file is read from.</param>
  207. <param name="sheetName">Name of the sheet.</param>
  208. <returns>The objects read from the Excel file.</returns>
  209. </member>
  210. <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.IO.Stream,System.Type,System.String)">
  211. <summary>
  212. Fetches objects from the specified sheet name.
  213. </summary>
  214. <param name="type">The type of objects the Excel file is mapped to.</param>
  215. <param name="stream">The stream the Excel file is read from.</param>
  216. <param name="sheetName">Name of the sheet.</param>
  217. <returns>The objects read from the Excel file.</returns>
  218. </member>
  219. <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.IO.Stream,System.Int32)">
  220. <summary>
  221. Fetches objects from the specified sheet index.
  222. </summary>
  223. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  224. <param name="stream">The stream the Excel file is read from.</param>
  225. <param name="sheetIndex">Index of the sheet.</param>
  226. <returns>The objects read from the Excel file.</returns>
  227. </member>
  228. <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.IO.Stream,System.Type,System.Int32)">
  229. <summary>
  230. Fetches objects from the specified sheet index.
  231. </summary>
  232. <param name="type">The type of objects the Excel file is mapped to.</param>
  233. <param name="stream">The stream the Excel file is read from.</param>
  234. <param name="sheetIndex">Index of the sheet.</param>
  235. <returns>The objects read from the Excel file.</returns>
  236. </member>
  237. <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String)">
  238. <summary>
  239. Fetches objects from the specified sheet name.
  240. </summary>
  241. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  242. <param name="sheetName">Name of the sheet.</param>
  243. <returns>The objects read from the Excel file.</returns>
  244. <exception cref="T:System.ArgumentOutOfRangeException">Thrown when a sheet is not found</exception>
  245. </member>
  246. <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.Type,System.String)">
  247. <summary>
  248. Fetches objects from the specified sheet name.
  249. </summary>
  250. <param name="type">The type of objects the Excel file is mapped to.</param>
  251. <param name="sheetName">Name of the sheet.</param>
  252. <returns>The objects read from the Excel file.</returns>
  253. <exception cref="T:System.ArgumentOutOfRangeException">Thrown when a sheet is not found</exception>
  254. </member>
  255. <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.Int32)">
  256. <summary>
  257. Fetches objects from the specified sheet index.
  258. </summary>
  259. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  260. <param name="sheetIndex">Index of the sheet.</param>
  261. <returns>The objects read from the Excel file.</returns>
  262. </member>
  263. <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.Type,System.Int32)">
  264. <summary>
  265. Fetches objects from the specified sheet index.
  266. </summary>
  267. <param name="type">The type of objects the Excel file is mapped to</param>
  268. <param name="sheetIndex">Index of the sheet.</param>
  269. <returns>The objects read from the Excel file.</returns>
  270. </member>
  271. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.String,System.String)">
  272. <summary>
  273. Fetches objects from the specified sheet name using async I/O.
  274. </summary>
  275. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  276. <param name="file">The path to the Excel file.</param>
  277. <param name="sheetName">Name of the sheet.</param>
  278. <returns>The objects read from the Excel file.</returns>
  279. </member>
  280. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.Type,System.String)">
  281. <summary>
  282. Fetches objects from the specified sheet name using async I/O.
  283. </summary>
  284. <param name="type">The type of objects the Excel file is mapped to.</param>
  285. <param name="file">The path to the Excel file.</param>
  286. <param name="sheetName">Name of the sheet.</param>
  287. <returns>The objects read from the Excel file.</returns>
  288. </member>
  289. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.String,System.Int32)">
  290. <summary>
  291. Fetches objects from the specified sheet index using async I/O.
  292. </summary>
  293. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  294. <param name="file">The path to the Excel file.</param>
  295. <param name="sheetIndex">Index of the sheet.</param>
  296. <returns>The objects read from the Excel file.</returns>
  297. </member>
  298. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.Type,System.Int32)">
  299. <summary>
  300. Fetches objects from the specified sheet index using async I/O.
  301. </summary>
  302. <param name="type">The type of objects the Excel file is mapped to.</param>
  303. <param name="file">The path to the Excel file.</param>
  304. <param name="sheetIndex">Index of the sheet.</param>
  305. <returns>The objects read from the Excel file.</returns>
  306. </member>
  307. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.IO.Stream,System.String)">
  308. <summary>
  309. Fetches objects from the specified sheet name using async I/O.
  310. </summary>
  311. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  312. <param name="stream">The stream the Excel file is read from.</param>
  313. <param name="sheetName">Name of the sheet.</param>
  314. <returns>The objects read from the Excel file.</returns>
  315. </member>
  316. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.IO.Stream,System.Type,System.String)">
  317. <summary>
  318. Fetches objects from the specified sheet name using async I/O.
  319. </summary>
  320. <param name="type">The type of objects the Excel file is mapped to.</param>
  321. <param name="stream">The stream the Excel file is read from.</param>
  322. <param name="sheetName">Name of the sheet.</param>
  323. <returns>The objects read from the Excel file.</returns>
  324. </member>
  325. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.IO.Stream,System.Int32)">
  326. <summary>
  327. Fetches objects from the specified sheet index using async I/O.
  328. </summary>
  329. <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
  330. <param name="stream">The stream the Excel file is read from.</param>
  331. <param name="sheetIndex">Index of the sheet.</param>
  332. <returns>The objects read from the Excel file.</returns>
  333. </member>
  334. <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.IO.Stream,System.Type,System.Int32)">
  335. <summary>
  336. Fetches objects from the specified sheet index using async I/O.
  337. </summary>
  338. <param name="type">The type of objects the Excel file is mapped to.</param>
  339. <param name="stream">The stream the Excel file is read from.</param>
  340. <param name="sheetIndex">Index of the sheet.</param>
  341. <returns>The objects read from the Excel file.</returns>
  342. </member>
  343. <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.String,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
  344. <summary>
  345. Saves the specified objects to the specified Excel file.
  346. </summary>
  347. <typeparam name="T">The type of objects to save.</typeparam>
  348. <param name="file">The path to the Excel file.</param>
  349. <param name="objects">The objects to save.</param>
  350. <param name="sheetName">Name of the sheet.</param>
  351. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  352. </member>
  353. <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.String,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
  354. <summary>
  355. Saves the specified objects to the specified Excel file.
  356. </summary>
  357. <typeparam name="T">The type of objects to save.</typeparam>
  358. <param name="file">The path to the Excel file.</param>
  359. <param name="objects">The objects to save.</param>
  360. <param name="sheetIndex">Index of the sheet.</param>
  361. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  362. </member>
  363. <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
  364. <summary>
  365. Saves the specified objects to the specified stream.
  366. </summary>
  367. <typeparam name="T">The type of objects to save.</typeparam>
  368. <param name="stream">The stream to save the objects to.</param>
  369. <param name="objects">The objects to save.</param>
  370. <param name="sheetName">Name of the sheet.</param>
  371. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  372. </member>
  373. <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
  374. <summary>
  375. Saves the specified objects to the specified stream.
  376. </summary>
  377. <typeparam name="T">The type of objects to save.</typeparam>
  378. <param name="stream">The stream to save the objects to.</param>
  379. <param name="objects">The objects to save.</param>
  380. <param name="sheetIndex">Index of the sheet.</param>
  381. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  382. </member>
  383. <member name="M:Ganss.Excel.ExcelMapper.Save(System.String,System.String,System.Boolean)">
  384. <summary>
  385. Saves tracked objects to the specified Excel file.
  386. </summary>
  387. <param name="file">The path to the Excel file.</param>
  388. <param name="sheetName">Name of the sheet.</param>
  389. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  390. </member>
  391. <member name="M:Ganss.Excel.ExcelMapper.Save(System.String,System.Int32,System.Boolean)">
  392. <summary>
  393. Saves tracked objects to the specified Excel file.
  394. </summary>
  395. <param name="file">The path to the Excel file.</param>
  396. <param name="sheetIndex">Index of the sheet.</param>
  397. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  398. </member>
  399. <member name="M:Ganss.Excel.ExcelMapper.Save(System.IO.Stream,System.String,System.Boolean)">
  400. <summary>
  401. Saves tracked objects to the specified stream.
  402. </summary>
  403. <param name="stream">The stream to save the objects to.</param>
  404. <param name="sheetName">Name of the sheet.</param>
  405. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  406. </member>
  407. <member name="M:Ganss.Excel.ExcelMapper.Save(System.IO.Stream,System.Int32,System.Boolean)">
  408. <summary>
  409. Saves tracked objects to the specified stream.
  410. </summary>
  411. <param name="stream">The stream to save the objects to.</param>
  412. <param name="sheetIndex">Index of the sheet.</param>
  413. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  414. </member>
  415. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.String,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
  416. <summary>
  417. Saves the specified objects to the specified Excel file using async I/O.
  418. </summary>
  419. <typeparam name="T">The type of objects to save.</typeparam>
  420. <param name="file">The path to the Excel file.</param>
  421. <param name="objects">The objects to save.</param>
  422. <param name="sheetName">Name of the sheet.</param>
  423. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  424. </member>
  425. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.String,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
  426. <summary>
  427. Saves the specified objects to the specified Excel file using async I/O.
  428. </summary>
  429. <typeparam name="T">The type of objects to save.</typeparam>
  430. <param name="file">The path to the Excel file.</param>
  431. <param name="objects">The objects to save.</param>
  432. <param name="sheetIndex">Index of the sheet.</param>
  433. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  434. </member>
  435. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
  436. <summary>
  437. Saves the specified objects to the specified stream using async I/O.
  438. </summary>
  439. <typeparam name="T">The type of objects to save.</typeparam>
  440. <param name="stream">The stream to save the objects to.</param>
  441. <param name="objects">The objects to save.</param>
  442. <param name="sheetName">Name of the sheet.</param>
  443. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  444. </member>
  445. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
  446. <summary>
  447. Saves the specified objects to the specified stream using async I/O.
  448. </summary>
  449. <typeparam name="T">The type of objects to save.</typeparam>
  450. <param name="stream">The stream to save the objects to.</param>
  451. <param name="objects">The objects to save.</param>
  452. <param name="sheetIndex">Index of the sheet.</param>
  453. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  454. </member>
  455. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.String,System.String,System.Boolean)">
  456. <summary>
  457. Saves tracked objects to the specified Excel file using async I/O.
  458. </summary>
  459. <param name="file">The path to the Excel file.</param>
  460. <param name="sheetName">Name of the sheet.</param>
  461. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  462. </member>
  463. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.String,System.Int32,System.Boolean)">
  464. <summary>
  465. Saves tracked objects to the specified Excel file using async I/O.
  466. </summary>
  467. <param name="file">The path to the Excel file.</param>
  468. <param name="sheetIndex">Index of the sheet.</param>
  469. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  470. </member>
  471. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.IO.Stream,System.String,System.Boolean)">
  472. <summary>
  473. Saves tracked objects to the specified stream using async I/O.
  474. </summary>
  475. <param name="stream">The stream to save the objects to.</param>
  476. <param name="sheetName">Name of the sheet.</param>
  477. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  478. </member>
  479. <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.IO.Stream,System.Int32,System.Boolean)">
  480. <summary>
  481. Saves tracked objects to the specified stream using async I/O.
  482. </summary>
  483. <param name="stream">The stream to save the objects to.</param>
  484. <param name="sheetIndex">Index of the sheet.</param>
  485. <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
  486. </member>
  487. <member name="M:Ganss.Excel.ExcelMapper.AddMapping``1(System.String,System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
  488. <summary>
  489. Adds a mapping from a column name to a property.
  490. </summary>
  491. <typeparam name="T"></typeparam>
  492. <param name="columnName">Name of the column.</param>
  493. <param name="propertyExpression">The property expression.</param>
  494. </member>
  495. <member name="M:Ganss.Excel.ExcelMapper.AddMapping``1(System.Int32,System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
  496. <summary>
  497. Adds a mapping from a column index to a property.
  498. </summary>
  499. <typeparam name="T"></typeparam>
  500. <param name="columnIndex">Index of the column.</param>
  501. <param name="propertyExpression">The property expression.</param>
  502. </member>
  503. <member name="M:Ganss.Excel.ExcelMapper.AddMapping(System.Type,System.String,System.String)">
  504. <summary>
  505. Adds a mapping from a column name to a property.
  506. </summary>
  507. <param name="t">The type that contains the property to map to.</param>
  508. <param name="columnName">Name of the column.</param>
  509. <param name="propertyName">Name of the property.</param>
  510. </member>
  511. <member name="M:Ganss.Excel.ExcelMapper.AddMapping(System.Type,System.Int32,System.String)">
  512. <summary>
  513. Adds a mapping from a column name to a property.
  514. </summary>
  515. <param name="t">The type that contains the property to map to.</param>
  516. <param name="columnIndex">Index of the column.</param>
  517. <param name="propertyName">Name of the property.</param>
  518. </member>
  519. <member name="M:Ganss.Excel.ExcelMapper.Ignore``1(System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
  520. <summary>
  521. Ignores a property.
  522. </summary>
  523. <typeparam name="T"></typeparam>
  524. <param name="propertyExpression">The property expression.</param>
  525. </member>
  526. <member name="M:Ganss.Excel.ExcelMapper.Ignore(System.Type,System.String)">
  527. <summary>
  528. Ignores a property.
  529. </summary>
  530. <param name="t">The type that contains the property to map to.</param>
  531. <param name="propertyName">Name of the property.</param>
  532. </member>
  533. <member name="T:Ganss.Excel.Exceptions.ExcelMapperConvertException">
  534. <summary>
  535. Represents an error that occurs when conversion of a cell value to the mapped property type fails.
  536. </summary>
  537. </member>
  538. <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.CellValue">
  539. <summary>
  540. Gets the original cell value.
  541. </summary>
  542. <value>
  543. The original cell value.
  544. </value>
  545. </member>
  546. <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.TargetType">
  547. <summary>
  548. Gets the type of the property that the cell is mapped to.
  549. </summary>
  550. <value>
  551. The type of the property that the cell is mapped to.
  552. </value>
  553. </member>
  554. <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.Line">
  555. <summary>
  556. Gets the line number of the cell where the error occurred.
  557. </summary>
  558. <value>
  559. The line number of the cell where the error occurred.
  560. </value>
  561. </member>
  562. <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.Column">
  563. <summary>
  564. Gets the column number of the cell where the error occurred.
  565. </summary>
  566. <value>
  567. The column number of the cell where the error occurred.
  568. </value>
  569. </member>
  570. <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor">
  571. <summary>
  572. Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
  573. </summary>
  574. </member>
  575. <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.String)">
  576. <summary>
  577. Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
  578. </summary>
  579. <param name="message">The message the describes the error.</param>
  580. </member>
  581. <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.String,System.Exception)">
  582. <summary>
  583. Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
  584. </summary>
  585. <param name="message">The message the describes the error.</param>
  586. <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
  587. </member>
  588. <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.Object,System.Type,System.Int32,System.Int32)">
  589. <summary>
  590. Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
  591. </summary>
  592. <param name="cellValue">The value of the cell where the error occurred.</param>
  593. <param name="targetType">The type of the property the cell is mapped to.</param>
  594. <param name="line">The line number of the cell where the error occurred.</param>
  595. <param name="column">The column number of the cell where the error occurred.</param>
  596. </member>
  597. <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.Object,System.Type,System.Int32,System.Int32,System.Exception)">
  598. <summary>
  599. Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
  600. </summary>
  601. <param name="cellValue">The value of the cell where the error occurred.</param>
  602. <param name="targetType">The type of the property the cell is mapped to.</param>
  603. <param name="line">The line number of the cell where the error occurred.</param>
  604. <param name="column">The column number of the cell where the error occurred.</param>
  605. <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
  606. </member>
  607. <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  608. <summary>
  609. Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class with serialized data.
  610. </summary>
  611. <param name="info">The object that holds the serialized data.</param>
  612. <param name="context">The contextual information about the source or destination.</param>
  613. </member>
  614. <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
  615. <summary>
  616. Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with information about the exception.
  617. </summary>
  618. <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
  619. <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
  620. </member>
  621. <member name="T:Ganss.Excel.FormulaResultAttribute">
  622. <summary>
  623. Attribute which specifies that the formula result instead of the formula should be mapped.
  624. This applies only to string properties, as for all other types the result will be mapped.
  625. </summary>
  626. <seealso cref="T:System.Attribute" />
  627. </member>
  628. <member name="T:Ganss.Excel.IgnoreAttribute">
  629. <summary>
  630. Attribute that specifies that a property should be ignored.
  631. </summary>
  632. <seealso cref="T:System.Attribute" />
  633. </member>
  634. <member name="T:Ganss.Excel.ITypeMapperFactory">
  635. <summary>
  636. A caching factory of <see cref="T:Ganss.Excel.TypeMapper"/> objects.
  637. </summary>
  638. </member>
  639. <member name="M:Ganss.Excel.ITypeMapperFactory.Create(System.Type)">
  640. <summary>
  641. Creates a <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.
  642. </summary>
  643. <param name="type">The type to create a <see cref="T:Ganss.Excel.TypeMapper"/> object for.</param>
  644. <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.</returns>
  645. </member>
  646. <member name="T:Ganss.Excel.ColumnInfo">
  647. <summary>
  648. Describes the mapping of a property to a cell in an Excel sheet.
  649. </summary>
  650. </member>
  651. <member name="P:Ganss.Excel.ColumnInfo.Property">
  652. <summary>
  653. Gets or sets the property.
  654. </summary>
  655. <value>
  656. The property.
  657. </value>
  658. </member>
  659. <member name="P:Ganss.Excel.ColumnInfo.IsNullable">
  660. <summary>
  661. Gets a value indicating whether the property is nullable.
  662. </summary>
  663. <value>
  664. <c>true</c> if the property is nullable; otherwise, <c>false</c>.
  665. </value>
  666. </member>
  667. <member name="P:Ganss.Excel.ColumnInfo.PropertyType">
  668. <summary>
  669. Gets the type of the property.
  670. </summary>
  671. <value>
  672. The type of the property.
  673. </value>
  674. </member>
  675. <member name="P:Ganss.Excel.ColumnInfo.SetCell">
  676. <summary>
  677. Gets or sets the cell setter.
  678. </summary>
  679. <value>
  680. The cell setter.
  681. </value>
  682. </member>
  683. <member name="P:Ganss.Excel.ColumnInfo.SetProp">
  684. <summary>
  685. Gets or sets the property setter.
  686. </summary>
  687. <value>
  688. The property setter.
  689. </value>
  690. </member>
  691. <member name="P:Ganss.Excel.ColumnInfo.BuiltinFormat">
  692. <summary>
  693. Gets or sets the builtin format.
  694. </summary>
  695. <value>
  696. The builtin format.
  697. </value>
  698. </member>
  699. <member name="P:Ganss.Excel.ColumnInfo.CustomFormat">
  700. <summary>
  701. Gets or sets the custom format.
  702. </summary>
  703. <value>
  704. The custom format.
  705. </value>
  706. </member>
  707. <member name="P:Ganss.Excel.ColumnInfo.FormulaResult">
  708. <summary>
  709. Gets or sets a value indicating whether to map the formula result.
  710. </summary>
  711. <value>
  712. <c>true</c> if the formula result will be mapped; otherwise, <c>false</c>.
  713. </value>
  714. </member>
  715. <member name="M:Ganss.Excel.ColumnInfo.SetColumnStyle(NPOI.SS.UserModel.ISheet,System.Int32)">
  716. <summary>Sets the column style.</summary>
  717. <param name="sheet">The sheet.</param>
  718. <param name="columnIndex">Index of the column.</param>
  719. </member>
  720. <member name="M:Ganss.Excel.ColumnInfo.SetCellStyle(NPOI.SS.UserModel.ICell)">
  721. <summary>Sets the cell style.</summary>
  722. <param name="c">The cell.</param>
  723. </member>
  724. <member name="M:Ganss.Excel.ColumnInfo.SetProperty(System.Object,System.Object)">
  725. <summary>
  726. Sets the property of the specified object to the specified value.
  727. </summary>
  728. <param name="o">The object whose property to set.</param>
  729. <param name="val">The value.</param>
  730. </member>
  731. <member name="M:Ganss.Excel.ColumnInfo.GetProperty(System.Object)">
  732. <summary>
  733. Gets the property value of the specified object.
  734. </summary>
  735. <param name="o">The o.</param>
  736. <returns></returns>
  737. </member>
  738. <member name="M:Ganss.Excel.ColumnInfo.SetCellUsing(System.Action{NPOI.SS.UserModel.ICell,System.Object})">
  739. <summary>Specifies a method to use when setting the cell value from an object.</summary>
  740. <param name="setCell">The method to use when setting the cell value from an object.</param>
  741. <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
  742. </member>
  743. <member name="M:Ganss.Excel.ColumnInfo.SetPropertyUsing(System.Func{System.Object,System.Object})">
  744. <summary>Specifies a method to use when setting the property value from the cell value.</summary>
  745. <param name="setProp">The method to use when setting the property value from the cell value.</param>
  746. <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
  747. </member>
  748. <member name="M:Ganss.Excel.ColumnInfo.AsFormulaResult">
  749. <summary>Selects formula results to be mapped instead of the formula itself.</summary>
  750. <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
  751. </member>
  752. <member name="M:Ganss.Excel.ColumnInfo.#ctor(System.Reflection.PropertyInfo)">
  753. <summary>
  754. Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnInfo"/> class.
  755. </summary>
  756. <param name="propertyInfo">The property information.</param>
  757. </member>
  758. <member name="T:Ganss.Excel.TypeMapper">
  759. <summary>
  760. Maps a <see cref="P:Ganss.Excel.TypeMapper.Type"/>'s properties to columns in an Excel sheet.
  761. </summary>
  762. </member>
  763. <member name="P:Ganss.Excel.TypeMapper.ColumnsByName">
  764. <summary>
  765. Gets or sets the columns by name.
  766. </summary>
  767. <value>
  768. The dictionary of columns by name.
  769. </value>
  770. </member>
  771. <member name="P:Ganss.Excel.TypeMapper.ColumnsByIndex">
  772. <summary>
  773. Gets or sets the columns by index.
  774. </summary>
  775. <value>
  776. The dictionary of columns by index.
  777. </value>
  778. </member>
  779. <member name="M:Ganss.Excel.TypeMapper.Create(System.Type)">
  780. <summary>
  781. Creates a <see cref="T:Ganss.Excel.TypeMapper"/> object from the specified type.
  782. </summary>
  783. <param name="type">The type.</param>
  784. <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> object.</returns>
  785. </member>
  786. <member name="M:Ganss.Excel.TypeMapper.GetColumnByName(System.String)">
  787. <summary>
  788. Gets the <see cref="T:Ganss.Excel.ColumnInfo"/> for the specified column name.
  789. </summary>
  790. <param name="name">The column name.</param>
  791. <returns>A <see cref="T:Ganss.Excel.ColumnInfo"/> object or null if no <see cref="T:Ganss.Excel.ColumnInfo"/> exists for the specified column name.</returns>
  792. </member>
  793. <member name="M:Ganss.Excel.TypeMapper.GetColumnByIndex(System.Int32)">
  794. <summary>
  795. Gets the <see cref="T:Ganss.Excel.ColumnInfo"/> for the specified column index.
  796. </summary>
  797. <param name="index">The column index.</param>
  798. <returns>A <see cref="T:Ganss.Excel.ColumnInfo"/> object or null if no <see cref="T:Ganss.Excel.ColumnInfo"/> exists for the specified column index.</returns>
  799. </member>
  800. <member name="T:Ganss.Excel.TypeMapperFactory">
  801. <summary>
  802. A caching factory of <see cref="T:Ganss.Excel.TypeMapper"/> objects.
  803. </summary>
  804. </member>
  805. <member name="M:Ganss.Excel.TypeMapperFactory.Create(System.Type)">
  806. <summary>
  807. Creates a <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.
  808. </summary>
  809. <param name="type">The type to create a <see cref="T:Ganss.Excel.TypeMapper"/> object for.</param>
  810. <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.</returns>
  811. </member>
  812. </members>
  813. </doc>