123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>ExcelMapper</name>
- </assembly>
- <members>
- <member name="T:Ganss.Excel.ColumnAttribute">
- <summary>
- Attribute that specifies the mapping of a property to a column in an Excel file.
- </summary>
- <seealso cref="T:System.Attribute" />
- </member>
- <member name="M:Ganss.Excel.ColumnAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
- </summary>
- <param name="name">The name of the column.</param>
- </member>
- <member name="M:Ganss.Excel.ColumnAttribute.#ctor(System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
- </summary>
- <param name="index">The index of the column.</param>
- </member>
- <member name="P:Ganss.Excel.ColumnAttribute.Name">
- <summary>
- Gets the name of the column.
- </summary>
- <value>
- The name of the column.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnAttribute.Index">
- <summary>
- Gets the index of the column.
- </summary>
- <value>
- The index of the column.
- </value>
- </member>
- <member name="T:Ganss.Excel.DataFormatAttribute">
- <summary>
- Attribute that specifies the data format of an Excel cell.
- The format can either be a <a href="https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html">builtin format</a>
- 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>.
- </summary>
- <seealso cref="T:System.Attribute" />
- </member>
- <member name="P:Ganss.Excel.DataFormatAttribute.BuiltinFormat">
- <summary>
- Gets or sets the builtin format, see https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html for possible values.
- </summary>
- <value>
- The builtin format.
- </value>
- </member>
- <member name="P:Ganss.Excel.DataFormatAttribute.CustomFormat">
- <summary>
- 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.
- </summary>
- <value>
- The custom format.
- </value>
- </member>
- <member name="M:Ganss.Excel.DataFormatAttribute.#ctor(System.Int16)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.DataFormatAttribute"/> class.
- </summary>
- <param name="format">The format, see https://poi.apache.org/apidocs/org/apache/poi/ss/usermodel/BuiltinFormats.html for possible values.</param>
- </member>
- <member name="M:Ganss.Excel.DataFormatAttribute.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.DataFormatAttribute"/> class.
- </summary>
- <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>
- </member>
- <member name="T:Ganss.Excel.ExcelMapper">
- <summary>
- Map objects to Excel files.
- </summary>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.TypeMapperFactory">
- <summary>
- Gets or sets the <see cref="T:Ganss.Excel.TypeMapper"/> factory.
- 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.
- </summary>
- <value>
- The <see cref="T:Ganss.Excel.TypeMapper"/> factory.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.HeaderRow">
- <summary>
- Gets or sets a value indicating whether the Excel file contains a header row of column names. Default is <c>true</c>.
- </summary>
- <value>
- <c>true</c> if the Excel file contains a header row; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.HeaderRowNumber">
- <summary>
- Gets or sets the row number of the header row. Default is 0.
- 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"/>.
- </summary>
- <value>
- The header row number.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.MinRowNumber">
- <summary>
- Gets or sets the minimum row number of the rows that may contain data. Default is 0.
- </summary>
- <value>
- The minimum row number.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.MaxRowNumber">
- <summary>
- Gets or sets the inclusive maximum row number of the rows that may contain data. Default is <see cref="F:System.Int32.MaxValue"/>.
- </summary>
- <value>
- The maximum row number.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.TrackObjects">
- <summary>
- Gets or sets a value indicating whether to track objects read from the Excel file. Default is true.
- If object tracking is enabled, the <see cref="T:Ganss.Excel.ExcelMapper"/> object keeps track of objects it yields through the Fetch() methods.
- You can then modify these objects and save them back to an Excel file without having to specify the list of objects to save.
- </summary>
- <value>
- <c>true</c> if object tracking is enabled; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.SkipBlankRows">
- <summary>
- Gets or sets a value indicating whether to skip blank rows when reading from Excel files. Default is true.
- </summary>
- <value>
- <c>true</c> if blank lines are skipped; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
- </summary>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.#ctor(NPOI.SS.UserModel.IWorkbook)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
- </summary>
- <param name="workbook">The workbook.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
- </summary>
- <param name="file">The path to the Excel file.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.#ctor(System.IO.Stream)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ExcelMapper"/> class.
- </summary>
- <param name="stream">The stream the Excel file is read from.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String,System.String)">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.Type,System.String)">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.Type,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.IO.Stream,System.String)">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.IO.Stream,System.Type,System.String)">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.IO.Stream,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.IO.Stream,System.Type,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String)">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when a sheet is not found</exception>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.Type,System.String)">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- <exception cref="T:System.ArgumentOutOfRangeException">Thrown when a sheet is not found</exception>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.Int32)">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.Type,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.String,System.String)">
- <summary>
- Fetches objects from the specified sheet name using async I/O.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.Type,System.String)">
- <summary>
- Fetches objects from the specified sheet name using async I/O.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.String,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index using async I/O.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.Type,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index using async I/O.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.IO.Stream,System.String)">
- <summary>
- Fetches objects from the specified sheet name using async I/O.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.IO.Stream,System.Type,System.String)">
- <summary>
- Fetches objects from the specified sheet name using async I/O.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetName">Name of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.IO.Stream,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index using async I/O.
- </summary>
- <typeparam name="T">The type of objects the Excel file is mapped to.</typeparam>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.IO.Stream,System.Type,System.Int32)">
- <summary>
- Fetches objects from the specified sheet index using async I/O.
- </summary>
- <param name="type">The type of objects the Excel file is mapped to.</param>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.String,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
- <summary>
- Saves the specified objects to the specified Excel file.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.String,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
- <summary>
- Saves the specified objects to the specified Excel file.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
- <summary>
- Saves the specified objects to the specified stream.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="stream">The stream to save the objects to.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
- <summary>
- Saves the specified objects to the specified stream.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="stream">The stream to save the objects to.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.String,System.String,System.Boolean)">
- <summary>
- Saves tracked objects to the specified Excel file.
- </summary>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.String,System.Int32,System.Boolean)">
- <summary>
- Saves tracked objects to the specified Excel file.
- </summary>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.IO.Stream,System.String,System.Boolean)">
- <summary>
- Saves tracked objects to the specified stream.
- </summary>
- <param name="stream">The stream to save the objects to.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.IO.Stream,System.Int32,System.Boolean)">
- <summary>
- Saves tracked objects to the specified stream.
- </summary>
- <param name="stream">The stream to save the objects to.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.String,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
- <summary>
- Saves the specified objects to the specified Excel file using async I/O.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.String,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
- <summary>
- Saves the specified objects to the specified Excel file using async I/O.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="file">The path to the Excel file.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
- <summary>
- Saves the specified objects to the specified stream using async I/O.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="stream">The stream to save the objects to.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean)">
- <summary>
- Saves the specified objects to the specified stream using async I/O.
- </summary>
- <typeparam name="T">The type of objects to save.</typeparam>
- <param name="stream">The stream to save the objects to.</param>
- <param name="objects">The objects to save.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.String,System.String,System.Boolean)">
- <summary>
- Saves tracked objects to the specified Excel file using async I/O.
- </summary>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.String,System.Int32,System.Boolean)">
- <summary>
- Saves tracked objects to the specified Excel file using async I/O.
- </summary>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.IO.Stream,System.String,System.Boolean)">
- <summary>
- Saves tracked objects to the specified stream using async I/O.
- </summary>
- <param name="stream">The stream to save the objects to.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.IO.Stream,System.Int32,System.Boolean)">
- <summary>
- Saves tracked objects to the specified stream using async I/O.
- </summary>
- <param name="stream">The stream to save the objects to.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="xlsx">if set to <c>true</c> saves in .xlsx format; otherwise, saves in .xls format.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.AddMapping``1(System.String,System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
- <summary>
- Adds a mapping from a column name to a property.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="columnName">Name of the column.</param>
- <param name="propertyExpression">The property expression.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.AddMapping``1(System.Int32,System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
- <summary>
- Adds a mapping from a column index to a property.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="columnIndex">Index of the column.</param>
- <param name="propertyExpression">The property expression.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.AddMapping(System.Type,System.String,System.String)">
- <summary>
- Adds a mapping from a column name to a property.
- </summary>
- <param name="t">The type that contains the property to map to.</param>
- <param name="columnName">Name of the column.</param>
- <param name="propertyName">Name of the property.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.AddMapping(System.Type,System.Int32,System.String)">
- <summary>
- Adds a mapping from a column name to a property.
- </summary>
- <param name="t">The type that contains the property to map to.</param>
- <param name="columnIndex">Index of the column.</param>
- <param name="propertyName">Name of the property.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Ignore``1(System.Linq.Expressions.Expression{System.Func{``0,System.Object}})">
- <summary>
- Ignores a property.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="propertyExpression">The property expression.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Ignore(System.Type,System.String)">
- <summary>
- Ignores a property.
- </summary>
- <param name="t">The type that contains the property to map to.</param>
- <param name="propertyName">Name of the property.</param>
- </member>
- <member name="T:Ganss.Excel.Exceptions.ExcelMapperConvertException">
- <summary>
- Represents an error that occurs when conversion of a cell value to the mapped property type fails.
- </summary>
- </member>
- <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.CellValue">
- <summary>
- Gets the original cell value.
- </summary>
- <value>
- The original cell value.
- </value>
- </member>
- <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.TargetType">
- <summary>
- Gets the type of the property that the cell is mapped to.
- </summary>
- <value>
- The type of the property that the cell is mapped to.
- </value>
- </member>
- <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.Line">
- <summary>
- Gets the line number of the cell where the error occurred.
- </summary>
- <value>
- The line number of the cell where the error occurred.
- </value>
- </member>
- <member name="P:Ganss.Excel.Exceptions.ExcelMapperConvertException.Column">
- <summary>
- Gets the column number of the cell where the error occurred.
- </summary>
- <value>
- The column number of the cell where the error occurred.
- </value>
- </member>
- <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
- </summary>
- </member>
- <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
- </summary>
- <param name="message">The message the describes the error.</param>
- </member>
- <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.String,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
- </summary>
- <param name="message">The message the describes the error.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
- </member>
- <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.Object,System.Type,System.Int32,System.Int32)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
- </summary>
- <param name="cellValue">The value of the cell where the error occurred.</param>
- <param name="targetType">The type of the property the cell is mapped to.</param>
- <param name="line">The line number of the cell where the error occurred.</param>
- <param name="column">The column number of the cell where the error occurred.</param>
- </member>
- <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.Object,System.Type,System.Int32,System.Int32,System.Exception)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class.
- </summary>
- <param name="cellValue">The value of the cell where the error occurred.</param>
- <param name="targetType">The type of the property the cell is mapped to.</param>
- <param name="line">The line number of the cell where the error occurred.</param>
- <param name="column">The column number of the cell where the error occurred.</param>
- <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
- </member>
- <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.#ctor(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.Exceptions.ExcelMapperConvertException"/> class with serialized data.
- </summary>
- <param name="info">The object that holds the serialized data.</param>
- <param name="context">The contextual information about the source or destination.</param>
- </member>
- <member name="M:Ganss.Excel.Exceptions.ExcelMapperConvertException.GetObjectData(System.Runtime.Serialization.SerializationInfo,System.Runtime.Serialization.StreamingContext)">
- <summary>
- Sets the <see cref="T:System.Runtime.Serialization.SerializationInfo"/> with information about the exception.
- </summary>
- <param name="info">The <see cref="T:System.Runtime.Serialization.SerializationInfo"/> that holds the serialized object data about the exception being thrown.</param>
- <param name="context">The <see cref="T:System.Runtime.Serialization.StreamingContext"/> that contains contextual information about the source or destination.</param>
- </member>
- <member name="T:Ganss.Excel.FormulaResultAttribute">
- <summary>
- Attribute which specifies that the formula result instead of the formula should be mapped.
- This applies only to string properties, as for all other types the result will be mapped.
- </summary>
- <seealso cref="T:System.Attribute" />
- </member>
- <member name="T:Ganss.Excel.IgnoreAttribute">
- <summary>
- Attribute that specifies that a property should be ignored.
- </summary>
- <seealso cref="T:System.Attribute" />
- </member>
- <member name="T:Ganss.Excel.ITypeMapperFactory">
- <summary>
- A caching factory of <see cref="T:Ganss.Excel.TypeMapper"/> objects.
- </summary>
- </member>
- <member name="M:Ganss.Excel.ITypeMapperFactory.Create(System.Type)">
- <summary>
- Creates a <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.
- </summary>
- <param name="type">The type to create a <see cref="T:Ganss.Excel.TypeMapper"/> object for.</param>
- <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.</returns>
- </member>
- <member name="T:Ganss.Excel.ColumnInfo">
- <summary>
- Describes the mapping of a property to a cell in an Excel sheet.
- </summary>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.Property">
- <summary>
- Gets or sets the property.
- </summary>
- <value>
- The property.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.IsNullable">
- <summary>
- Gets a value indicating whether the property is nullable.
- </summary>
- <value>
- <c>true</c> if the property is nullable; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.PropertyType">
- <summary>
- Gets the type of the property.
- </summary>
- <value>
- The type of the property.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.SetCell">
- <summary>
- Gets or sets the cell setter.
- </summary>
- <value>
- The cell setter.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.SetProp">
- <summary>
- Gets or sets the property setter.
- </summary>
- <value>
- The property setter.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.BuiltinFormat">
- <summary>
- Gets or sets the builtin format.
- </summary>
- <value>
- The builtin format.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.CustomFormat">
- <summary>
- Gets or sets the custom format.
- </summary>
- <value>
- The custom format.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.FormulaResult">
- <summary>
- Gets or sets a value indicating whether to map the formula result.
- </summary>
- <value>
- <c>true</c> if the formula result will be mapped; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.SetColumnStyle(NPOI.SS.UserModel.ISheet,System.Int32)">
- <summary>Sets the column style.</summary>
- <param name="sheet">The sheet.</param>
- <param name="columnIndex">Index of the column.</param>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.SetCellStyle(NPOI.SS.UserModel.ICell)">
- <summary>Sets the cell style.</summary>
- <param name="c">The cell.</param>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.SetProperty(System.Object,System.Object)">
- <summary>
- Sets the property of the specified object to the specified value.
- </summary>
- <param name="o">The object whose property to set.</param>
- <param name="val">The value.</param>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.GetProperty(System.Object)">
- <summary>
- Gets the property value of the specified object.
- </summary>
- <param name="o">The o.</param>
- <returns></returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.SetCellUsing(System.Action{NPOI.SS.UserModel.ICell,System.Object})">
- <summary>Specifies a method to use when setting the cell value from an object.</summary>
- <param name="setCell">The method to use when setting the cell value from an object.</param>
- <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.SetPropertyUsing(System.Func{System.Object,System.Object})">
- <summary>Specifies a method to use when setting the property value from the cell value.</summary>
- <param name="setProp">The method to use when setting the property value from the cell value.</param>
- <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.AsFormulaResult">
- <summary>Selects formula results to be mapped instead of the formula itself.</summary>
- <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.#ctor(System.Reflection.PropertyInfo)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnInfo"/> class.
- </summary>
- <param name="propertyInfo">The property information.</param>
- </member>
- <member name="T:Ganss.Excel.TypeMapper">
- <summary>
- Maps a <see cref="P:Ganss.Excel.TypeMapper.Type"/>'s properties to columns in an Excel sheet.
- </summary>
- </member>
- <member name="P:Ganss.Excel.TypeMapper.ColumnsByName">
- <summary>
- Gets or sets the columns by name.
- </summary>
- <value>
- The dictionary of columns by name.
- </value>
- </member>
- <member name="P:Ganss.Excel.TypeMapper.ColumnsByIndex">
- <summary>
- Gets or sets the columns by index.
- </summary>
- <value>
- The dictionary of columns by index.
- </value>
- </member>
- <member name="M:Ganss.Excel.TypeMapper.Create(System.Type)">
- <summary>
- Creates a <see cref="T:Ganss.Excel.TypeMapper"/> object from the specified type.
- </summary>
- <param name="type">The type.</param>
- <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.TypeMapper.GetColumnByName(System.String)">
- <summary>
- Gets the <see cref="T:Ganss.Excel.ColumnInfo"/> for the specified column name.
- </summary>
- <param name="name">The column name.</param>
- <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>
- </member>
- <member name="M:Ganss.Excel.TypeMapper.GetColumnByIndex(System.Int32)">
- <summary>
- Gets the <see cref="T:Ganss.Excel.ColumnInfo"/> for the specified column index.
- </summary>
- <param name="index">The column index.</param>
- <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>
- </member>
- <member name="T:Ganss.Excel.TypeMapperFactory">
- <summary>
- A caching factory of <see cref="T:Ganss.Excel.TypeMapper"/> objects.
- </summary>
- </member>
- <member name="M:Ganss.Excel.TypeMapperFactory.Create(System.Type)">
- <summary>
- Creates a <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.
- </summary>
- <param name="type">The type to create a <see cref="T:Ganss.Excel.TypeMapper"/> object for.</param>
- <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> for the specified type.</returns>
- </member>
- </members>
- </doc>
|