12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463 |
- <?xml version="1.0"?>
- <doc>
- <assembly>
- <name>ExcelMapper</name>
- </assembly>
- <members>
- <member name="T:Ganss.Excel.ActionInvoker">
- <summary>
- Abstract class action invoker
- </summary>
- </member>
- <member name="M:Ganss.Excel.ActionInvoker.Invoke(System.Object,System.Int32)">
- <summary>
- Invoke from an unspecified <paramref name="obj"/> type
- </summary>
- <param name="obj">mapping instance class</param>
- <param name="index">index in the collection</param>
- </member>
- <member name="M:Ganss.Excel.ActionInvoker.CreateInstance``1(System.Action{``0,System.Int32})">
- <summary>
- <see cref="T:Ganss.Excel.ActionInvokerImpl`1"/> factory
- </summary>
- <typeparam name="T"></typeparam>
- <param name="mappingAction"></param>
- <returns></returns>
- </member>
- <member name="T:Ganss.Excel.ActionInvokerImpl`1">
- <summary>
- Generic form <see cref="T:Ganss.Excel.ActionInvoker"/>
- </summary>
- <typeparam name="T"></typeparam>
- </member>
- <member name="F:Ganss.Excel.ActionInvokerImpl`1.mappingAction">
- <summary>
- ref to the mapping action.
- </summary>
- </member>
- <member name="M:Ganss.Excel.ActionInvokerImpl`1.#ctor(System.Action{`0,System.Int32})">
- <summary>
- Ctor
- </summary>
- <param name="mappingAction"></param>
- </member>
- <member name="M:Ganss.Excel.ActionInvokerImpl`1.Invoke(System.Object,System.Int32)">
- <summary>
- Invoke Generic Action
- </summary>
- <param name="obj"></param>
- <param name="index"></param>
- </member>
- <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,Ganss.Excel.MappingDirections)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
- </summary>
- <param name="name">The name of the column.</param>
- <param name="directions">mapping direction</param>
- </member>
- <member name="M:Ganss.Excel.ColumnAttribute.#ctor(System.Int32,Ganss.Excel.MappingDirections)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
- </summary>
- <param name="index">The index of the column.</param>
- <param name="directions">mapping direction</param>
- </member>
- <member name="M:Ganss.Excel.ColumnAttribute.#ctor(System.Int32,System.String,Ganss.Excel.MappingDirections)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
- </summary>
- <param name="index">The index of the column.</param>
- <param name="name">The name of the column.</param>
- <param name="directions">mapping direction</param>
- </member>
- <member name="M:Ganss.Excel.ColumnAttribute.#ctor(Ganss.Excel.MappingDirections)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnAttribute"/> class.
- </summary>
- <param name="directions">mapping direction</param>
- </member>
- <member name="P:Ganss.Excel.ColumnAttribute.Directions">
- <summary>
- Gets the direction of the column.
- </summary>
- <value>
- The name of the column.
- </value>
- </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="P:Ganss.Excel.ColumnAttribute.Letter">
- <summary>
- Gets or sets the column name in Excel letter format where A refers to column 1 etc.
- </summary>
- </member>
- <member name="P:Ganss.Excel.ColumnAttribute.Inherit">
- <summary>
- Gets or sets a value that indicates whether this attribute is inherited by derived classes.
- It is useful if you want to prevent multiple mappings created by attributes in derived classes.
- The default value is true.
- </summary>
- </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.FormulaAttribute">
- <summary>
- Attribute which specifies that the property contains a formula.
- This applies only to string properties and is only needed when saving Excel files.
- </summary>
- <seealso cref="T:System.Attribute" />
- </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.JsonAttribute">
- <summary>
- Attribute that specifies that the property should be serialized as JSON.
- </summary>
- <seealso cref="T:System.Attribute" />
- </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.Directions">
- <summary>
- Gets or sets the mapping directions.
- </summary>
- </member>
- <member name="F:Ganss.Excel.ColumnInfo.defaultCellSetter">
- <summary>
- Gets or sets the default cell setter.
- </summary>
- </member>
- <member name="F:Ganss.Excel.ColumnInfo.customCellSetter">
- <summary>
- Gets or sets the custom cell setter.
- </summary>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.SetPropertyType(System.Type)">
- <summary>
- Sets the property type.
- </summary>
- <param name="propertyType">The property type.</param>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.Name">
- <summary>
- Gets or sets the property name.
- </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.IsSubType">
- <summary>
- Gets a value indicating whether the mapped property has a nested type.
- </summary>
- </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="P:Ganss.Excel.ColumnInfo.Formula">
- <summary>
- Gets or sets a value indicating whether to save the property as a formula cell. Only needed when saving.
- </summary>
- <value>
- <c>true</c> if the cell will contain a formula; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Ganss.Excel.ColumnInfo.Json">
- <summary>
- Gets or sets a value indicating whether to serialize as JSON.
- </summary>
- <value>
- <c>true</c> if the property will be serialized as JSON; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="F:Ganss.Excel.ColumnInfo.NumericTypes">
- <summary>
- Types that map a numeric column.
- </summary>
- </member>
- <member name="F:Ganss.Excel.ColumnInfo.DateTypes">
- <summary>
- Types that map to a DateTime column.
- </summary>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.GenerateCellSetter">
- <summary>
- Generates the cell setter.
- </summary>
- <returns>The cell setter.</returns>
- </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.GetPropertyValue(System.Object,System.Object,NPOI.SS.UserModel.ICell)">
- <summary>
- Computes value that can be assigned to property from cell value.
- </summary>
- <param name="o">The object which contains the property.</param>
- <param name="val">The value.</param>
- <param name="cell">The cell where the value originates from.</param>
- <returns>Value that can be assigned to property.</returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.SetProperty(System.Object,System.Object,NPOI.SS.UserModel.ICell)">
- <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>
- <param name="cell">The cell where the value originates from.</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 object from which to get the property value.</param>
- <returns>The property value.</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.SetCellUsing``1(System.Action{NPOI.SS.UserModel.ICell,``0})">
- <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.SetPropertyUsing(System.Func{System.Object,NPOI.SS.UserModel.ICell,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.SetPropertyUsing(System.Func{System.Object,System.Object,NPOI.SS.UserModel.ICell,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.SetPropertyUsing``1(System.Func{``0,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.SetPropertyUsing``1(System.Func{``0,System.Object,NPOI.SS.UserModel.ICell,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.AsFormula">
- <summary>Selects the property to be saved as a formula.</summary>
- <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.AsJson">
- <summary>Selects the property to be serialized as JSON.</summary>
- <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.#ctor(System.Reflection.PropertyInfo,Ganss.Excel.MappingDirections)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnInfo"/> class.
- </summary>
- <param name="propertyInfo">The property information.</param>
- <param name="direction">Data direction</param>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.#ctor">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ColumnInfo"/> class.
- </summary>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.FromExcelOnly">
- <summary>Selects the property to be unidirectional from Excel to Object.</summary>
- <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.ColumnInfo.ToExcelOnly">
- <summary>Selects the property to be unidirectional from Excel to Object.</summary>
- <returns>The <see cref="T:Ganss.Excel.ColumnInfo"/> object.</returns>
- </member>
- <member name="T:Ganss.Excel.DynamicColumnInfo">
- <summary>
- Describes the mapping of an <see cref="T:System.Dynamic.ExpandoObject"/>'s property to a cell.
- </summary>
- </member>
- <member name="P:Ganss.Excel.DynamicColumnInfo.Index">
- <summary>
- Gets or sets the column index.
- </summary>
- </member>
- <member name="M:Ganss.Excel.DynamicColumnInfo.#ctor(System.Int32,System.String)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.DynamicColumnInfo"/> class.
- </summary>
- <param name="index">The column index.</param>
- <param name="name">The column name.</param>
- </member>
- <member name="M:Ganss.Excel.DynamicColumnInfo.#ctor(System.String,System.Type)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.DynamicColumnInfo"/> class.
- </summary>
- <param name="name">The column name.</param>
- <param name="t">The type of the column.</param>
- </member>
- <member name="M:Ganss.Excel.DynamicColumnInfo.SetProperty(System.Object,System.Object,NPOI.SS.UserModel.ICell)">
- <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>
- <param name="cell">The cell where the value originates from.</param>
- </member>
- <member name="M:Ganss.Excel.DynamicColumnInfo.GetProperty(System.Object)">
- <summary>
- Gets the property value of the specified object.
- </summary>
- <param name="o">The o.</param>
- <returns>The property value.</returns>
- </member>
- <member name="T:Ganss.Excel.MappingDirections">
- <summary>
- Data direction
- </summary>
- </member>
- <member name="F:Ganss.Excel.MappingDirections.ExcelToObject">
- <summary>
- From Excel to Object
- </summary>
- </member>
- <member name="F:Ganss.Excel.MappingDirections.ObjectToExcel">
- <summary>
- From Object to Excel
- </summary>
- </member>
- <member name="F:Ganss.Excel.MappingDirections.Both">
- <summary>
- Both directions
- </summary>
- </member>
- <member name="T:Ganss.Excel.SavingEventArgs">
- <summary>
- Provides data for the <see cref="E:Ganss.Excel.ExcelMapper.Saving"/> event.
- </summary>
- </member>
- <member name="P:Ganss.Excel.SavingEventArgs.Sheet">
- <summary>
- Gets or sets the sheet.
- </summary>
- <value>
- The sheet.
- </value>
- </member>
- <member name="M:Ganss.Excel.SavingEventArgs.#ctor(NPOI.SS.UserModel.ISheet)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.SavingEventArgs"/> class.
- </summary>
- <param name="sheet">The sheet that is being saved.</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="P:Ganss.Excel.ExcelMapper.SkipBlankCells">
- <summary>
- Gets or sets a value indicating whether to skip blank cells 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="P:Ganss.Excel.ExcelMapper.CreateMissingHeaders">
- <summary>
- Gets or sets a value indicating whether to create columns in existing Excel files for properties where
- the corresponding header does not yet exist. If this is false and properties are mapped by name,
- their corresponding headers must already be present in existing files.
- Default is false.
- </summary>
- <value>
- <c>true</c> if missing headers should be created; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.IgnoreNestedTypes">
- <summary>
- Gets or sets a value indicating whether to ignore nested types.
- Default is false.
- </summary>
- <value>
- <c>true</c> if nested types should be ignored; otherwise, <c>false</c>.
- </value>
- </member>
- <member name="P:Ganss.Excel.ExcelMapper.DataFormatter">
- <summary>
- Gets or sets the <see cref="P:Ganss.Excel.ExcelMapper.DataFormatter"/> object to use when formatting cell values.
- </summary>
- <value>
- The <see cref="P:Ganss.Excel.ExcelMapper.DataFormatter"/> object to use when formatting cell values.
- </value>
- </member>
- <member name="E:Ganss.Excel.ExcelMapper.Saving">
- <summary>
- Occurs before saving and allows the workbook to be manipulated.
- </summary>
- </member>
- <member name="E:Ganss.Excel.ExcelMapper.ErrorParsingCell">
- <summary>
- Occurs while parsing when value is not convertible.
- Set Cancel to <c>true</c> to Cancel Exception, also, see <see cref="T:Ganss.Excel.ParsingErrorEventArgs"/>
- </summary>
- </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.Attach(NPOI.SS.UserModel.IWorkbook)">
- <summary>
- Attaches the Excel file from the provided <see cref="T:NPOI.SS.UserModel.IWorkbook"/>.
- </summary>
- <param name="workbook">The workbook.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Attach(System.String)">
- <summary>
- Attaches the Excel file from the provided path.
- </summary>
- <param name="file">The path to the Excel file.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Attach(System.IO.Stream)">
- <summary>
- Attaches the Excel file read from the provided <see cref="T:System.IO.Stream"/>.
- </summary>
- <param name="stream">The stream the Excel file is read from.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.CreateInstance``1(System.Func{``0})">
- <summary>
- Sets a factory function to create objects of type <typeparamref name="T"/>.
- </summary>
- <typeparam name="T">The type of objects to create.</typeparam>
- <param name="factory">The factory function.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String,System.String,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.Type,System.String,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.String,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.Type,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.String,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <param name="file">The path to the Excel file.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.IO.Stream,System.String,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</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,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.IO.Stream,System.String,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.IO.Stream,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</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,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.IO.Stream,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch``1(System.String,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</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,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</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.String,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches objects from the specified sheet name.
- </summary>
- <param name="sheetName">Name of the sheet.</param>
- <param name="valueParser">Allow value parsing</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,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.Type,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Fetch(System.Int32,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches objects from the specified sheet index.
- </summary>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.String,System.String,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.String,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches dynamic objects from the specified sheet name 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="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.Type,System.String,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.String,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches dynamic objects from the specified sheet index 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="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.String,System.Type,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.IO.Stream,System.String,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.IO.Stream,System.String,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches dynamic objects from the specified sheet name using async I/O.
- </summary>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetName">Name of the sheet.</param>
- <param name="valueParser">Allow value parsing</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,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync``1(System.IO.Stream,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchAsync(System.IO.Stream,System.Int32,System.Func{System.String,System.Object,System.Object})">
- <summary>
- Fetches dynamic objects from the specified sheet index using async I/O.
- </summary>
- <param name="stream">The stream the Excel file is read from.</param>
- <param name="sheetIndex">Index of the sheet.</param>
- <param name="valueParser">Allow value parsing</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,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueParser">Allow value parsing</param>
- <returns>The objects read from the Excel file.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchSheetNames">
- <summary>
- Fetches the names of all sheets.
- </summary>
- <returns>The sheet names.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.FetchSheetNames(System.Boolean)">
- <summary>
- Fetches the names of all sheets.
- </summary>
- <param name="ignoreHidden">Indicates if hidden sheets should be ignored.</param>
- <returns>The sheet names.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.String,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.String,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.String,System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.String,System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.IO.Stream,System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.Save(System.IO.Stream,System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.String,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.String,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync``1(System.IO.Stream,System.Collections.Generic.IEnumerable{``0},System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.String,System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.String,System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.IO.Stream,System.String,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.SaveAsync(System.IO.Stream,System.Int32,System.Boolean,System.Func{System.String,System.Object,System.Object})">
- <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>
- <param name="valueConverter">converter receiving property name and value</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.AddAfterMapping``1(System.Action{``0,System.Int32})">
- <summary>
- Action to call after an object is mapped
- </summary>
- <typeparam name="T"></typeparam>
- <param name="action"></param>
- <returns></returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.AddBeforeMapping``1(System.Action{``0,System.Int32})">
- <summary>
- Action to call before an object is mapped
- </summary>
- <typeparam name="T"></typeparam>
- <param name="action"></param>
- <returns></returns>
- </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="M:Ganss.Excel.ExcelMapper.NormalizeUsing``1(System.Func{System.String,System.String})">
- <summary>
- Sets a name normalization function.
- This function is used when the <see cref="T:Ganss.Excel.ExcelMapper"/> object tries to find a property name from a header cell value.
- It can be used if the input header cell values may contain a larger number of possible values that can be easily mapped
- backed to a single property name through a function, e.g. if the header cell may contain varying amounts of whitespace.
- The default is the identity function.
- </summary>
- <typeparam name="T"></typeparam>
- <param name="normalizeName">The name normalization function.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.NormalizeUsing(System.Type,System.Func{System.String,System.String})">
- <summary>
- Sets a name normalization function.
- This function is used when the <see cref="T:Ganss.Excel.ExcelMapper"/> object tries to find a property name from a header cell value.
- It can be used if the input header cell values may contain a larger number of possible values that can be easily mapped
- backed to a single property name through a function, e.g. if the header cell may contain varying amounts of whitespace.
- The default is the identity function.
- </summary>
- <param name="t">The type that contains the property to map to.</param>
- <param name="normalizeName">The name normalization function.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.NormalizeUsing(System.Func{System.String,System.String})">
- <summary>
- Sets a default name normalization function.
- This function is used when the <see cref="T:Ganss.Excel.ExcelMapper"/> object tries to find a property name from a header cell value.
- It can be used if the input header cell values may contain a larger number of possible values that can be easily mapped
- backed to a single property name through a function, e.g. if the header cell may contain varying amounts of whitespace.
- This default normalization function works across types. If a normalization function is set for a specific type it takes
- precedence over this default function.
- The default is the identity function.
- </summary>
- <param name="normalizeName">The name normalization function.</param>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.LetterToIndex(System.String)">
- <summary>
- Converts Excel column letters to column indexes (e.g. "A" yields 1).
- </summary>
- <param name="letter">The Excel column letter.</param>
- <returns>The column index.</returns>
- </member>
- <member name="M:Ganss.Excel.ExcelMapper.IndexToLetter(System.Int32)">
- <summary>
- Converts a column index to the corresponding Excel column letter or letters (e.g. 1 yields "A").
- </summary>
- <param name="index">The column index.</param>
- <returns>The Excel column letter or letters.</returns>
- </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="M:Ganss.Excel.Extensions.ConvertToNullableType(System.Type)">
- <summary>
- convert to Nullable type
- </summary>
- <param name="type"></param>
- <returns></returns>
- </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="M:Ganss.Excel.ITypeMapperFactory.Create(System.Object)">
- <summary>
- Creates a <see cref="T:Ganss.Excel.TypeMapper"/> for the specified object.
- </summary>
- <param name="o">The object to create a <see cref="T:Ganss.Excel.TypeMapper"/> object for.</param>
- <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> for the specified object.</returns>
- </member>
- <member name="T:Ganss.Excel.ParsingErrorEventArgs">
- <summary>
- Provides data for the <see cref="E:Ganss.Excel.ExcelMapper.ErrorParsingCell"/> event.
- Event handler can allow parsing to continue by setting <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> to true,
- cancelling the exception.
- </summary>
- </member>
- <member name="P:Ganss.Excel.ParsingErrorEventArgs.Error">
- <summary>
- The error captured
- </summary>
- </member>
- <member name="M:Ganss.Excel.ParsingErrorEventArgs.#ctor(Ganss.Excel.Exceptions.ExcelMapperConvertException)">
- <summary>
- Initializes a new instance of the <see cref="T:Ganss.Excel.ParsingErrorEventArgs"/> class.
- </summary>
- <param name="error">The error captured.</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.Type">
- <summary>
- Gets the type being mapped.
- </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="P:Ganss.Excel.TypeMapper.BeforeMappingActionInvoker">
- <summary>
- Gets or sets the Before Mapping action.
- </summary>
- </member>
- <member name="P:Ganss.Excel.TypeMapper.AfterMappingActionInvoker">
- <summary>
- Gets or sets the After Mapping action.
- </summary>
- </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.Create(System.Collections.Generic.IEnumerable{NPOI.SS.UserModel.ICell},System.Boolean)">
- <summary>
- Creates a <see cref="T:Ganss.Excel.TypeMapper"/> object from a list of cells.
- </summary>
- <param name="columns">The cells.</param>
- <param name="useContentAsName"><c>true</c> if the cell's contents should be used as the column name; otherwise, <c>false</c>.</param>
- <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.TypeMapper.Create(System.Dynamic.ExpandoObject)">
- <summary>
- Creates a <see cref="T:Ganss.Excel.TypeMapper"/> object from an <see cref="T:System.Dynamic.ExpandoObject"/> object.
- </summary>
- <param name="o">The <see cref="T:System.Dynamic.ExpandoObject"/> object.</param>
- <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> object.</returns>
- </member>
- <member name="M:Ganss.Excel.TypeMapper.CreateExpando">
- <summary>
- Creates an <see cref="T:System.Dynamic.ExpandoObject"/> object that includes type mapping information.
- </summary>
- <returns>An <see cref="T:System.Dynamic.ExpandoObject"/> object.</returns>
- </member>
- <member name="P:Ganss.Excel.TypeMapper.Constructor">
- <summary>
- Gets or sets the constructor to initialize the mapped type. Only used if the mapped type has no default constructor.
- </summary>
- </member>
- <member name="P:Ganss.Excel.TypeMapper.ConstructorParams">
- <summary>
- Gets or sets the constructor parameters by name.
- </summary>
- </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>
- <member name="M:Ganss.Excel.TypeMapperFactory.Create(System.Object)">
- <summary>
- Creates a <see cref="T:Ganss.Excel.TypeMapper"/> for the specified object.
- </summary>
- <param name="o">The object to create a <see cref="T:Ganss.Excel.TypeMapper"/> object for.</param>
- <returns>A <see cref="T:Ganss.Excel.TypeMapper"/> for the specified object.</returns>
- </member>
- </members>
- </doc>
|