ClosedXML.Parser.xml 88 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>ClosedXML.Parser</name>
  5. </assembly>
  6. <members>
  7. <member name="T:ClosedXML.Parser.BinaryOperation">
  8. <summary>
  9. Binary operations that can occur in the formula.
  10. </summary>
  11. </member>
  12. <member name="F:ClosedXML.Parser.BinaryOperation.Concat">
  13. <summary><c>&amp;</c></summary>
  14. </member>
  15. <member name="F:ClosedXML.Parser.BinaryOperation.Addition">
  16. <summary><c>+</c></summary>
  17. </member>
  18. <member name="F:ClosedXML.Parser.BinaryOperation.Subtraction">
  19. <summary><c>-</c></summary>
  20. </member>
  21. <member name="F:ClosedXML.Parser.BinaryOperation.Multiplication">
  22. <summary><c>*</c></summary>
  23. </member>
  24. <member name="F:ClosedXML.Parser.BinaryOperation.Division">
  25. <summary><c>/</c></summary>
  26. </member>
  27. <member name="F:ClosedXML.Parser.BinaryOperation.Power">
  28. <summary><c>^</c></summary>
  29. </member>
  30. <member name="F:ClosedXML.Parser.BinaryOperation.GreaterOrEqualThan">
  31. <summary><c>&gt;=</c></summary>
  32. </member>
  33. <member name="F:ClosedXML.Parser.BinaryOperation.LessOrEqualThan">
  34. <summary><c>&lt;=</c></summary>
  35. </member>
  36. <member name="F:ClosedXML.Parser.BinaryOperation.LessThan">
  37. <summary><c>&lt;</c></summary>
  38. </member>
  39. <member name="F:ClosedXML.Parser.BinaryOperation.GreaterThan">
  40. <summary><c>&gt;</c></summary>
  41. </member>
  42. <member name="F:ClosedXML.Parser.BinaryOperation.NotEqual">
  43. <summary><c>!=</c></summary>
  44. </member>
  45. <member name="F:ClosedXML.Parser.BinaryOperation.Equal">
  46. <summary><c>=</c></summary>
  47. </member>
  48. <member name="F:ClosedXML.Parser.BinaryOperation.Union">
  49. <summary><c>,</c></summary>
  50. </member>
  51. <member name="F:ClosedXML.Parser.BinaryOperation.Intersection">
  52. <summary><c>SPACE</c></summary>
  53. </member>
  54. <member name="F:ClosedXML.Parser.BinaryOperation.Range">
  55. <summary><c>:</c></summary>
  56. </member>
  57. <member name="T:ClosedXML.Parser.CopyVisitor">
  58. <summary>
  59. A visitor that generates the identical formula for the parsed formula based on passed arguments.
  60. CopyVisitor doesn't make any judgements if passed arguments have been modified. It just makes
  61. a newly allocated copy based on passed values.
  62. </summary>
  63. </member>
  64. <member name="M:ClosedXML.Parser.CopyVisitor.LogicalValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Boolean)">
  65. <inheritdoc />
  66. </member>
  67. <member name="M:ClosedXML.Parser.CopyVisitor.NumberValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Double)">
  68. <inheritdoc />
  69. </member>
  70. <member name="M:ClosedXML.Parser.CopyVisitor.TextValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  71. <inheritdoc />
  72. </member>
  73. <member name="M:ClosedXML.Parser.CopyVisitor.ErrorValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char})">
  74. <inheritdoc />
  75. </member>
  76. <member name="M:ClosedXML.Parser.CopyVisitor.ArrayNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.Int32,System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  77. <inheritdoc />
  78. </member>
  79. <member name="M:ClosedXML.Parser.CopyVisitor.BlankNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange)">
  80. <inheritdoc />
  81. </member>
  82. <member name="M:ClosedXML.Parser.CopyVisitor.LogicalNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Boolean)">
  83. <inheritdoc />
  84. </member>
  85. <member name="M:ClosedXML.Parser.CopyVisitor.ErrorNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char})">
  86. <inheritdoc />
  87. </member>
  88. <member name="M:ClosedXML.Parser.CopyVisitor.NumberNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Double)">
  89. <inheritdoc />
  90. </member>
  91. <member name="M:ClosedXML.Parser.CopyVisitor.TextNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  92. <inheritdoc />
  93. </member>
  94. <member name="M:ClosedXML.Parser.CopyVisitor.Reference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.ReferenceArea)">
  95. <inheritdoc />
  96. </member>
  97. <member name="M:ClosedXML.Parser.CopyVisitor.SheetReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,ClosedXML.Parser.ReferenceArea)">
  98. <inheritdoc />
  99. </member>
  100. <member name="M:ClosedXML.Parser.CopyVisitor.BangReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.ReferenceArea)">
  101. <inheritdoc />
  102. </member>
  103. <member name="M:ClosedXML.Parser.CopyVisitor.Reference3D(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,System.String,ClosedXML.Parser.ReferenceArea)">
  104. <inheritdoc />
  105. </member>
  106. <member name="M:ClosedXML.Parser.CopyVisitor.ExternalSheetReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,ClosedXML.Parser.ReferenceArea)">
  107. <inheritdoc />
  108. </member>
  109. <member name="M:ClosedXML.Parser.CopyVisitor.ExternalReference3D(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.String,ClosedXML.Parser.ReferenceArea)">
  110. <inheritdoc />
  111. </member>
  112. <member name="M:ClosedXML.Parser.CopyVisitor.Function(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  113. <inheritdoc />
  114. </member>
  115. <member name="M:ClosedXML.Parser.CopyVisitor.ExternalFunction(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  116. <inheritdoc />
  117. </member>
  118. <member name="M:ClosedXML.Parser.CopyVisitor.Function(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  119. <inheritdoc />
  120. </member>
  121. <member name="M:ClosedXML.Parser.CopyVisitor.ExternalFunction(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  122. <inheritdoc />
  123. </member>
  124. <member name="M:ClosedXML.Parser.CopyVisitor.CellFunction(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.RowCol,System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  125. <inheritdoc />
  126. </member>
  127. <member name="M:ClosedXML.Parser.CopyVisitor.StructureReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  128. <inheritdoc />
  129. </member>
  130. <member name="M:ClosedXML.Parser.CopyVisitor.StructureReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  131. <inheritdoc />
  132. </member>
  133. <member name="M:ClosedXML.Parser.CopyVisitor.ExternalStructureReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  134. <inheritdoc />
  135. </member>
  136. <member name="M:ClosedXML.Parser.CopyVisitor.Name(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  137. <inheritdoc />
  138. </member>
  139. <member name="M:ClosedXML.Parser.CopyVisitor.SheetName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,System.String)">
  140. <inheritdoc />
  141. </member>
  142. <member name="M:ClosedXML.Parser.CopyVisitor.BangName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  143. <inheritdoc />
  144. </member>
  145. <member name="M:ClosedXML.Parser.CopyVisitor.ExternalName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String)">
  146. <inheritdoc />
  147. </member>
  148. <member name="M:ClosedXML.Parser.CopyVisitor.ExternalSheetName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.String)">
  149. <inheritdoc />
  150. </member>
  151. <member name="M:ClosedXML.Parser.CopyVisitor.BinaryNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.BinaryOperation,ClosedXML.Parser.TransformedSymbol,ClosedXML.Parser.TransformedSymbol)">
  152. <inheritdoc />
  153. </member>
  154. <member name="M:ClosedXML.Parser.CopyVisitor.Unary(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.UnaryOperation,ClosedXML.Parser.TransformedSymbol)">
  155. <inheritdoc />
  156. </member>
  157. <member name="M:ClosedXML.Parser.CopyVisitor.Nested(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.TransformedSymbol)">
  158. <inheritdoc />
  159. </member>
  160. <member name="T:ClosedXML.Parser.FormulaConverter">
  161. <summary>
  162. Convert between <em>A1</em> and <em>R1C1</em> style formulas.
  163. </summary>
  164. </member>
  165. <member name="M:ClosedXML.Parser.FormulaConverter.ToR1C1(System.String,System.Int32,System.Int32)">
  166. <summary>
  167. Convert a formula in <em>A1</em> form to the <em>R1C1</em> form.
  168. </summary>
  169. <param name="formulaA1">Formula text.</param>
  170. <param name="row">The row origin of R1C1, from 1 to 1048576.</param>
  171. <param name="col">The column origin of R1C1, from 1 to 16384.</param>
  172. <returns>Formula converted to R1C1.</returns>
  173. <exception cref="T:ClosedXML.Parser.ParsingException">The formula is not parseable.</exception>
  174. </member>
  175. <member name="M:ClosedXML.Parser.FormulaConverter.ToA1(System.String,System.Int32,System.Int32)">
  176. <summary>
  177. Convert a formula in <em>R1C1</em> form to the <em>A1</em> form.
  178. </summary>
  179. <param name="formulaR1C1">Formula text in R1C1.</param>
  180. <param name="row">The row origin of R1C1, from 1 to 1048576.</param>
  181. <param name="col">The column origin of R1C1, from 1 to 16384.</param>
  182. <returns>Formula converted to A1.</returns>
  183. <exception cref="T:ClosedXML.Parser.ParsingException">The formula is not parseable.</exception>
  184. </member>
  185. <member name="M:ClosedXML.Parser.FormulaConverter.ModifyA1(System.String,System.Int32,System.Int32,ClosedXML.Parser.IAstFactory{ClosedXML.Parser.TransformedSymbol,ClosedXML.Parser.TransformedSymbol,ClosedXML.Parser.ModContext})">
  186. <summary>
  187. Modify the formula using the passed <paramref name="factory"/>.
  188. </summary>
  189. <param name="formulaA1">Original formula in A1 style.</param>
  190. <param name="row">Row number of formula.</param>
  191. <param name="col">Column number of formula.</param>
  192. <param name="factory">Visitor to transform the formula.</param>
  193. </member>
  194. <member name="M:ClosedXML.Parser.FormulaConverter.ModifyA1(System.String,System.String,System.Int32,System.Int32,ClosedXML.Parser.IAstFactory{ClosedXML.Parser.TransformedSymbol,ClosedXML.Parser.TransformedSymbol,ClosedXML.Parser.ModContext})">
  195. <summary>
  196. Modify the formula using the passed <paramref name="factory"/>.
  197. </summary>
  198. <param name="formulaA1">Original formula in A1 style.</param>
  199. <param name="sheet">Name of the sheet where is the formula.</param>
  200. <param name="row">Row number of formula.</param>
  201. <param name="col">Column number of formula.</param>
  202. <param name="factory">Visitor to transform the formula.</param>
  203. </member>
  204. <member name="T:ClosedXML.Parser.FormulaParser`3">
  205. <summary>
  206. A parser of Excel formulas, with main purpose of creating an abstract syntax tree.
  207. </summary>
  208. <remarks>
  209. An implementation is a recursive descent parser, based on the ANTLR grammar.
  210. </remarks>
  211. <typeparam name="TScalarValue">Type of a scalar value used across expressions.</typeparam>
  212. <typeparam name="TNode">Type of a node used in the AST.</typeparam>
  213. <typeparam name="TContext">A context of the parsing. It's passed to every factory method and can contain global info that doesn't belong individual nodes.</typeparam>
  214. </member>
  215. <member name="F:ClosedXML.Parser.FormulaParser`3._a1Mode">
  216. <summary>
  217. Is parser in A1 mode (true) or R1C1 mode (false)?
  218. </summary>
  219. </member>
  220. <member name="M:ClosedXML.Parser.FormulaParser`3.CellFormulaA1(System.String,`2,ClosedXML.Parser.IAstFactory{`0,`1,`2})">
  221. <summary>
  222. Parse a formula using A1 semantic for references.
  223. </summary>
  224. <param name="formula">Formula text that will be parsed.</param>
  225. <param name="context">Context that is going to be passed to every method of the <paramref name="factory"/>.</param>
  226. <param name="factory">Factory to create nodes of AST tree.</param>
  227. <exception cref="T:ClosedXML.Parser.ParsingException">If the formula doesn't satisfy the grammar.</exception>
  228. </member>
  229. <member name="M:ClosedXML.Parser.FormulaParser`3.CellFormulaR1C1(System.String,`2,ClosedXML.Parser.IAstFactory{`0,`1,`2})">
  230. <summary>
  231. Parse a formula using R1C1 semantic for references.
  232. </summary>
  233. <param name="formula">Formula text that will be parsed.</param>
  234. <param name="context">Context that is going to be passed to every method of the <paramref name="factory"/>.</param>
  235. <param name="factory">Factory to create nodes of AST tree.</param>
  236. <exception cref="T:ClosedXML.Parser.ParsingException">If the formula doesn't satisfy the grammar.</exception>
  237. </member>
  238. <member name="M:ClosedXML.Parser.FormulaParser`3.PrefixAtomExpression(System.Boolean,System.Boolean@)">
  239. <summary>
  240. Parser for two rules unified into a single method.
  241. <para>
  242. <c>
  243. prefix_atom_expression
  244. : (PLUS | MINUS) prefix_atom_expression
  245. | atom_expression
  246. ;
  247. </c>
  248. <c>
  249. arg_prefix_atom_expression
  250. : (PLUS | MINUS) arg_prefix_atom_expression
  251. | arg_atom_expression
  252. ;
  253. </c>
  254. </para>
  255. </summary>
  256. <param name="skipRangeUnion">Does the method represent <c>prefix_atom_expression</c> (<c>false</c>) or <c>arg_prefix_atom_expression</c> (<c>true</c>)</param>
  257. <param name="isPureRef">Is the expression of the node a reference expression?</param>
  258. <returns></returns>
  259. </member>
  260. <member name="M:ClosedXML.Parser.FormulaParser`3.RefImplicitExpression(System.Boolean,`1)">
  261. <summary>
  262. <code>
  263. ref_implicit_expression
  264. : INTERSECT ref_implicit_expression
  265. | ref_intersection_expression
  266. ;
  267. </code>
  268. </summary>
  269. </member>
  270. <member name="M:ClosedXML.Parser.FormulaParser`3.RefSpillExpression(System.Boolean,`1)">
  271. <summary>
  272. Parser of the following node.
  273. <c>
  274. ref_spill_expression
  275. : ref_atom_expression SPILL?
  276. ;
  277. </c>
  278. </summary>
  279. </member>
  280. <member name="M:ClosedXML.Parser.FormulaParser`3.A1Reference">
  281. <summary>
  282. <code>
  283. a1_reference
  284. : A1_CELL
  285. | A1_CELL COLON A1_CELL
  286. | A1_SPAN_REFERENCE
  287. ;
  288. </code>
  289. </summary>
  290. </member>
  291. <member name="T:ClosedXML.Parser.IAstFactory`3">
  292. <summary>
  293. A factory used to create an AST through <see cref="T:ClosedXML.Parser.FormulaParser`3"/>.
  294. </summary>
  295. <remarks>
  296. Sheet names are in most cases strings, while most other texts are <c>ReadOnlySpan&lt;char&gt;</c>.
  297. The reason is that sheet name is always used as-is and in some methods is null, while
  298. other parameters might be processed. E.g. errors are likely to be transformed to enum, function name
  299. might need conversion from text <c>IFS</c> to <c>_xlfn.IFS</c> and so on.
  300. </remarks>
  301. <typeparam name="TScalarValue">Type of a scalar value used across expressions.</typeparam>
  302. <typeparam name="TNode">Type of a node used in the AST.</typeparam>
  303. <typeparam name="TContext">A context of the parsing. It's passed to every factory method and can contain global info that doesn't belong individual nodes.</typeparam>
  304. </member>
  305. <member name="M:ClosedXML.Parser.IAstFactory`3.LogicalValue(`2,ClosedXML.Parser.SymbolRange,System.Boolean)">
  306. <summary>
  307. Create a logical value for an array item.
  308. </summary>
  309. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  310. <param name="range">Symbol range of the logical token in the formula.</param>
  311. <param name="value">The logical value of an array.</param>
  312. </member>
  313. <member name="M:ClosedXML.Parser.IAstFactory`3.NumberValue(`2,ClosedXML.Parser.SymbolRange,System.Double)">
  314. <summary>
  315. Create a numerical value for an array item.
  316. </summary>
  317. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  318. <param name="range">Symbol range of the number token in the formula.</param>
  319. <param name="value">The numeric value of an array. Never <c>NaN</c> or <c>Infinity</c>.</param>
  320. </member>
  321. <member name="M:ClosedXML.Parser.IAstFactory`3.TextValue(`2,ClosedXML.Parser.SymbolRange,System.String)">
  322. <summary>
  323. Create a text value for an array item.
  324. </summary>
  325. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  326. <param name="range">Symbol range of the text token in the formula.</param>
  327. <param name="text">The text. The characters of text are already unescaped.</param>
  328. </member>
  329. <member name="M:ClosedXML.Parser.IAstFactory`3.ErrorValue(`2,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char})">
  330. <summary>
  331. Create an error for an array item.
  332. </summary>
  333. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  334. <param name="range">Symbol range of the error token in the formula.</param>
  335. <param name="error">The error text, string with <c>#</c> until the end of an error. No whitespace, converted to upper case, no matter the input.</param>
  336. </member>
  337. <member name="M:ClosedXML.Parser.IAstFactory`3.ArrayNode(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.Int32,System.Collections.Generic.IReadOnlyList{`0})">
  338. <summary>
  339. Create an array for scalar values.
  340. </summary>
  341. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  342. <param name="range">Symbol range of the array symbol in the formula.</param>
  343. <param name="rows">Number of rows of an array. At least 1.</param>
  344. <param name="columns">Number of column of an array. At least 1.</param>
  345. <param name="elements">Elements of an array, row by row. The number of elements is <paramref name="rows"/>*<paramref name="columns"/>.</param>
  346. </member>
  347. <member name="M:ClosedXML.Parser.IAstFactory`3.BlankNode(`2,ClosedXML.Parser.SymbolRange)">
  348. <summary>
  349. Create a blank node. In most cases, a blank argument of a function, e.g. <c>IF(TRUE,,)</c>.
  350. </summary>
  351. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  352. <param name="range">Range in a formula that contains the blank.</param>
  353. </member>
  354. <member name="M:ClosedXML.Parser.IAstFactory`3.LogicalNode(`2,ClosedXML.Parser.SymbolRange,System.Boolean)">
  355. <summary>
  356. Create a node with a logical value.
  357. </summary>
  358. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  359. <param name="range">Range in a formula that contains the logical.</param>
  360. <param name="value">The logical value that will be represented by the node.</param>
  361. </member>
  362. <member name="M:ClosedXML.Parser.IAstFactory`3.ErrorNode(`2,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char})">
  363. <summary>
  364. Create a node with an error value.
  365. </summary>
  366. <remarks>
  367. Sheet related ref errors (e.g. <c>Sheet!REF!</c> or <c>#REF!$A$4</c>) are also use this node. In that case,
  368. the <paramref name="range"/> contains whole section used to create the error, but <paramref name="error"/>
  369. contains normalized <c>#REF!</c> error.
  370. </remarks>
  371. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  372. <param name="range">Range in a formula that contains the error.</param>
  373. <param name="error">The error text, string with <c>#</c> until the end of an error. No whitespace. In upper case format.</param>
  374. </member>
  375. <member name="M:ClosedXML.Parser.IAstFactory`3.NumberNode(`2,ClosedXML.Parser.SymbolRange,System.Double)">
  376. <summary>
  377. Create a node with an error value.
  378. </summary>
  379. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  380. <param name="range">Range in a formula that contains the number.</param>
  381. <param name="value">The numeric value of an array. Never <c>NaN</c> or <c>Infinity</c>.</param>
  382. </member>
  383. <member name="M:ClosedXML.Parser.IAstFactory`3.TextNode(`2,ClosedXML.Parser.SymbolRange,System.String)">
  384. <summary>
  385. Create a node with a text value.
  386. </summary>
  387. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  388. <param name="range">Range in a formula that contains the text.</param>
  389. <param name="text">The text. The characters of text are already unescaped.</param>
  390. </member>
  391. <member name="M:ClosedXML.Parser.IAstFactory`3.Reference(`2,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.ReferenceArea)">
  392. <summary>
  393. Create a node for a reference to cells without a worksheet.
  394. </summary>
  395. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  396. <param name="range">Range in a formula that contains the reference.</param>
  397. <param name="reference">The referenced area.</param>
  398. </member>
  399. <member name="M:ClosedXML.Parser.IAstFactory`3.SheetReference(`2,ClosedXML.Parser.SymbolRange,System.String,ClosedXML.Parser.ReferenceArea)">
  400. <summary>
  401. Create a node for a reference in a specific sheet.
  402. </summary>
  403. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  404. <param name="range">Range in a formula that contains the sheet reference.</param>
  405. <param name="sheet">Name of a sheet (unescaped) of the <paramref name="reference"/>.</param>
  406. <param name="reference">Area in the sheet.</param>
  407. </member>
  408. <member name="M:ClosedXML.Parser.IAstFactory`3.BangReference(`2,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.ReferenceArea)">
  409. <summary>
  410. Create a node that processes a bang reference in a formula (e.g <c>"Branch:" &amp; !$C$5</c>). Bang reference should
  411. <list>
  412. <item>Be used only in defined names.</item>
  413. <item>Always be absolute (name doesn't have an anchor).</item>
  414. </list>
  415. </summary>
  416. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  417. <param name="range">Range in a formula that contains the bang reference.</param>
  418. <param name="reference">Area in the sheet.</param>
  419. </member>
  420. <member name="M:ClosedXML.Parser.IAstFactory`3.Reference3D(`2,ClosedXML.Parser.SymbolRange,System.String,System.String,ClosedXML.Parser.ReferenceArea)">
  421. <summary>
  422. Create a node for a 3D reference.
  423. </summary>
  424. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  425. <param name="range">Range in a formula that contains the 3D reference.</param>
  426. <param name="firstSheet">First sheet of 3D reference.</param>
  427. <param name="lastSheet">Last sheet of 3D reference.</param>
  428. <param name="reference">Area in all sheets of 3D reference.</param>
  429. </member>
  430. <member name="M:ClosedXML.Parser.IAstFactory`3.ExternalSheetReference(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.String,ClosedXML.Parser.ReferenceArea)">
  431. <summary>
  432. Create a node for a reference to cells of a specific sheet in a different worksheet.
  433. </summary>
  434. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  435. <param name="range">Range in a formula that contains the external sheet reference.</param>
  436. <param name="workbookIndex">Id of an external workbook. The actual path to the file is in workbook part, <c>externalReferences</c> tag.</param>
  437. <param name="sheet">Name of a sheet (unescaped) of the <paramref name="reference"/>.</param>
  438. <param name="reference">Area the external sheet.</param>
  439. </member>
  440. <member name="M:ClosedXML.Parser.IAstFactory`3.ExternalReference3D(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.String,ClosedXML.Parser.ReferenceArea)">
  441. <summary>
  442. Create a node for a 3D reference in a different workbook.
  443. </summary>
  444. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  445. <param name="range">Range in a formula that contains the external 3D reference.</param>
  446. <param name="workbookIndex">Id of an external workbook. The actual path to the file is in workbook part, <c>externalReferences</c> tag.</param>
  447. <param name="firstSheet">First sheet of 3D reference.</param>
  448. <param name="lastSheet">Last sheet of 3D reference.</param>
  449. <param name="reference">Area in all sheets of 3D reference.</param>
  450. </member>
  451. <member name="M:ClosedXML.Parser.IAstFactory`3.Function(`2,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{`1})">
  452. <summary>
  453. Create a node for a function.
  454. </summary>
  455. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  456. <param name="range">Range in a formula that contains the function including arguments.</param>
  457. <param name="functionName">Name of a function.</param>
  458. <param name="arguments">Nodes of argument values.</param>
  459. </member>
  460. <member name="M:ClosedXML.Parser.IAstFactory`3.Function(`2,ClosedXML.Parser.SymbolRange,System.String,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{`1})">
  461. <summary>
  462. Create a node for a function on a sheet. Might happen for VBA.
  463. </summary>
  464. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  465. <param name="range"></param>
  466. <param name="sheetName">Name of a sheet.</param>
  467. <param name="functionName">Name of a function.</param>
  468. <param name="args">Nodes of argument values.</param>
  469. </member>
  470. <member name="M:ClosedXML.Parser.IAstFactory`3.ExternalFunction(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{`1})">
  471. <summary>
  472. Create a node for a sheet-scoped function from an external workbook.
  473. </summary>
  474. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  475. <param name="range"></param>
  476. <param name="workbookIndex">Id of an external workbook. The actual path to the file is in workbook part, <c>externalReferences</c> tag.</param>
  477. <param name="sheetName">Name of a sheet in external workbook.</param>
  478. <param name="functionName">Name of the function.</param>
  479. <param name="arguments">Nodes of argument values.</param>
  480. </member>
  481. <member name="M:ClosedXML.Parser.IAstFactory`3.ExternalFunction(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{`1})">
  482. <summary>
  483. Create a node for a function from an external workbook.
  484. </summary>
  485. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  486. <param name="range">Range in a formula that contains the function including arguments.</param>
  487. <param name="workbookIndex">Id of an external workbook. The actual path to the file is in workbook part, <c>externalReferences</c> tag.</param>
  488. <param name="functionName">Name of the function.</param>
  489. <param name="arguments">Nodes of argument values.</param>
  490. </member>
  491. <member name="M:ClosedXML.Parser.IAstFactory`3.CellFunction(`2,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.RowCol,System.Collections.Generic.IReadOnlyList{`1})">
  492. <summary>
  493. Create a cell function. It references another function that should likely contain a LAMBDA value.
  494. </summary>
  495. <remarks>Cell functions are not yet supported by Excel, but are part of a grammar.</remarks>
  496. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  497. <param name="range">Range in a formula that contains the cell function.</param>
  498. <param name="cell">A reference to a cell with a LAMBDA. Is a single cell.</param>
  499. <param name="arguments">Arguments to pass to a LAMBDA.</param>
  500. </member>
  501. <member name="M:ClosedXML.Parser.IAstFactory`3.StructureReference(`2,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  502. <summary>
  503. Create a node to represent a structure reference without a table to a range of columns.
  504. Such reference is only allowed in the table (e.g. total formulas).
  505. </summary>
  506. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  507. <param name="range">Range in a formula that contains the structure reference.</param>
  508. <param name="area">A portion of a table that should be considered.</param>
  509. <param name="firstColumn">The first column of a range. Null, if whole table. If only one column, same as <paramref name="lastColumn"/>.</param>
  510. <param name="lastColumn">The last column of a range. Null, if whole table.If only one column, same as <paramref name="firstColumn"/>.</param>
  511. </member>
  512. <member name="M:ClosedXML.Parser.IAstFactory`3.StructureReference(`2,ClosedXML.Parser.SymbolRange,System.String,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  513. <summary>
  514. Create a node to represent a structure reference to a table.
  515. </summary>
  516. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  517. <param name="range">Range in a formula that contains the structure reference.</param>
  518. <param name="table">A name of a table.</param>
  519. <param name="area">A portion of a table that should be considered.</param>
  520. <param name="firstColumn">The first column of a range. Null, if whole table. If only one column, same as <paramref name="lastColumn"/>.</param>
  521. <param name="lastColumn">The last column of a range. Null, if whole table.If only one column, same as <paramref name="firstColumn"/>.</param>
  522. </member>
  523. <member name="M:ClosedXML.Parser.IAstFactory`3.ExternalStructureReference(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.String,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  524. <summary>
  525. Create a node to represent a structure reference to a table in some other workbook.
  526. </summary>
  527. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  528. <param name="range">Range in a formula that contains the structure reference.</param>
  529. <param name="workbookIndex">Id of external workbook.</param>
  530. <param name="table">A name of a table.</param>
  531. <param name="area">A portion of a table that should be considered.</param>
  532. <param name="firstColumn">The first column of a range. Null, if whole table. If only one column, same as <paramref name="lastColumn"/>.</param>
  533. <param name="lastColumn">The last column of a range. Null, if whole table.If only one column, same as <paramref name="firstColumn"/>.</param>
  534. </member>
  535. <member name="M:ClosedXML.Parser.IAstFactory`3.Name(`2,ClosedXML.Parser.SymbolRange,System.String)">
  536. <summary>
  537. Create a node that should evaluate to a value of a name defined in a workbook.
  538. </summary>
  539. <remarks>
  540. Name can be any formula, though in most cases, it is a cell reference. Also note that
  541. names can be global (usable in a whole workbook) or local (only for one worksheet).
  542. </remarks>
  543. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  544. <param name="range">Range in a formula that contains the name.</param>
  545. <param name="name">The defined name.</param>
  546. </member>
  547. <member name="M:ClosedXML.Parser.IAstFactory`3.SheetName(`2,ClosedXML.Parser.SymbolRange,System.String,System.String)">
  548. <summary>
  549. Create a node that should evaluate to a value of a name defined in a worksheet.
  550. </summary>
  551. <remarks>
  552. Name can be any formula, though in most cases, it is a cell reference. Also note that
  553. names can be global (usable in a whole workbook) or local (only for one worksheet).
  554. </remarks>
  555. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  556. <param name="range">Range in a formula that contains the name.</param>
  557. <param name="sheet">Name of a sheet, unescaped.</param>
  558. <param name="name">The defined name.</param>
  559. </member>
  560. <member name="M:ClosedXML.Parser.IAstFactory`3.BangName(`2,ClosedXML.Parser.SymbolRange,System.String)">
  561. <summary>
  562. Create a node that processes a bang name in a formula (e.g <c>"Branch:" &amp; !Data</c>). Bang reference should
  563. be used only in defined names.
  564. </summary>
  565. <remarks>
  566. TODO: This method is not yet implemented, just added so I don't have to deal with API breakage.
  567. </remarks>
  568. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  569. <param name="range">Range in a formula that contains the bang reference.</param>
  570. <param name="name">The defined name.</param>
  571. </member>
  572. <member name="M:ClosedXML.Parser.IAstFactory`3.ExternalName(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.String)">
  573. <summary>
  574. Create a node that should evaluate to a value of a defined name in a different workbook.
  575. </summary>
  576. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  577. <param name="range"></param>
  578. <param name="workbookIndex">Id of an external workbook. The actual path to the file is in workbook part, <c>externalReferences</c> tag.</param>
  579. <param name="name">Name from a workbook. It can be defined name or a name of a table.</param>
  580. </member>
  581. <member name="M:ClosedXML.Parser.IAstFactory`3.ExternalSheetName(`2,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.String)">
  582. <summary>
  583. Create a node that should evaluate to a value of a defined name in a worksheet of a different workbook.
  584. </summary>
  585. <remarks>
  586. Name can be any formula, though in most cases, it is a cell reference. Also note that
  587. names can be global (usable in a whole workbook) or local (only for one worksheet).
  588. </remarks>
  589. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  590. <param name="range">Range in a formula that contains the name.</param>
  591. <param name="workbookIndex">Id of an external workbook. The actual path to the file is in workbook part, <c>externalReferences</c> tag.</param>
  592. <param name="sheet">Name of a sheet in the external workbook, unescaped.</param>
  593. <param name="name">The defined name.</param>
  594. </member>
  595. <member name="M:ClosedXML.Parser.IAstFactory`3.BinaryNode(`2,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.BinaryOperation,`1,`1)">
  596. <summary>
  597. Create a node that performs a binary operation on values from another nodes.
  598. </summary>
  599. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  600. <param name="range">Range in a formula that contains the binary operation.</param>
  601. <param name="operation">Binary operation.</param>
  602. <param name="leftNode">Node that should be evaluated for left argument of a binary operation.</param>
  603. <param name="rightNode">Node that should be evaluated for right argument of a binary operation.</param>
  604. </member>
  605. <member name="M:ClosedXML.Parser.IAstFactory`3.Unary(`2,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.UnaryOperation,`1)">
  606. <summary>
  607. Create a node that performs an unary operation on a value from another node.
  608. </summary>
  609. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  610. <param name="range"></param>
  611. <param name="operation">Unary operation.</param>
  612. <param name="node">Node that should be evaluated for a value.</param>
  613. </member>
  614. <member name="M:ClosedXML.Parser.IAstFactory`3.Nested(`2,ClosedXML.Parser.SymbolRange,`1)">
  615. <summary>
  616. This factory method is called for nested expression in braces (<c>(1+2)/4</c>). The problem isn't that
  617. it would be evaluated incorrectly, but it is to preserve braces during A1 to R1C1 transformation.
  618. </summary>
  619. <param name="context">User supplied context for parsing a tree that is an argument of a parsing method.</param>
  620. <param name="range"></param>
  621. <param name="node">The node representing expression in braces.</param>
  622. <remarks>Simplest implementation returns the same node and avoids extra nodes.</remarks>
  623. </member>
  624. <member name="T:ClosedXML.Parser.ModContext">
  625. <summary>
  626. A context for modifications of a formula through <see cref="T:ClosedXML.Parser.CopyVisitor"/>.
  627. </summary>
  628. </member>
  629. <member name="M:ClosedXML.Parser.ModContext.#ctor(System.String,System.Int32,System.Int32,System.Boolean)">
  630. <summary>
  631. Create a context for modifying formulas.
  632. </summary>
  633. </member>
  634. <member name="M:ClosedXML.Parser.ModContext.#ctor(System.String,System.String,System.Int32,System.Int32,System.Boolean)">
  635. <summary>
  636. Create a context for modifying formulas.
  637. </summary>
  638. </member>
  639. <member name="P:ClosedXML.Parser.ModContext.Formula">
  640. <summary>
  641. The original formula without any modifications.
  642. </summary>
  643. </member>
  644. <member name="P:ClosedXML.Parser.ModContext.Sheet">
  645. <summary>
  646. Name of the current sheet.
  647. </summary>
  648. </member>
  649. <member name="P:ClosedXML.Parser.ModContext.Row">
  650. <summary>
  651. Absolute row number in a sheet.
  652. </summary>
  653. </member>
  654. <member name="P:ClosedXML.Parser.ModContext.Col">
  655. <summary>
  656. Absolute column number in a sheet.
  657. </summary>
  658. </member>
  659. <member name="P:ClosedXML.Parser.ModContext.IsA1">
  660. <summary>
  661. Should references in formula be A1?
  662. </summary>
  663. </member>
  664. <member name="T:ClosedXML.Parser.NameUtils">
  665. <summary>
  666. A class for checking whether an identifier in a formula requires quotes or
  667. can can be used without quotes. This is an Excel custom behavior, unrelated
  668. to the unicode standard. The grammar defines a behavior, but that is not
  669. how Excel behaves. Microsoft likely made a selection based on each
  670. individual language without any connection to Unicode codepoint categories
  671. (e.g. it likely marked quote-like symbols from each language as requiring
  672. quotes). Data used in the methods were collected directly from Excel using
  673. AutoHotKey script.
  674. </summary>
  675. </member>
  676. <member name="F:ClosedXML.Parser.NameUtils.QuoteFirst">
  677. <summary>
  678. A bitmask indicating if the sheet name with first codepoint should be quoted.
  679. Generated by `Generate_sheet_quotation_data`. BitArray is fast and takes up only
  680. few KiB.
  681. </summary>
  682. </member>
  683. <member name="F:ClosedXML.Parser.NameUtils.QuoteNext">
  684. <summary>
  685. A bitmask indicating if the sheet name with next such codepoint should be quoted.
  686. Generated by `Generate_sheet_quotation_data`. BitArray is fast and takes up only
  687. few KiB.
  688. </summary>
  689. </member>
  690. <member name="F:ClosedXML.Parser.NameUtils.InvalidSheetChars">
  691. <summary>
  692. Character not allowed in a sheet name, even quoted one.
  693. </summary>
  694. </member>
  695. <member name="M:ClosedXML.Parser.NameUtils.ShouldQuote(System.ReadOnlySpan{System.Char})">
  696. <summary>
  697. Should the name be quoted?
  698. </summary>
  699. <remarks>
  700. Sheet names can't contain <c>*</c>,<c>/</c>,<c>:</c>,<c>?</c>,<c>[</c>,<c>\</c>,
  701. <c>]</c>, but method doesn't check for that. Also, it can't start with <c>'</c>,
  702. though it can be non-first character.
  703. </remarks>
  704. <param name="name">The name. Must be at least 1 char long.</param>
  705. <returns>True, if the sheet name should be quoted in formula.</returns>
  706. <exception cref="T:System.ArgumentException">If name is empty.</exception>
  707. </member>
  708. <member name="M:ClosedXML.Parser.NameUtils.IsSheetNameValid(System.ReadOnlySpan{System.Char})">
  709. <summary>
  710. Is the name of a sheet valid?
  711. </summary>
  712. <param name="sheetName">Name of the sheet.</param>
  713. </member>
  714. <member name="T:ClosedXML.Parser.ParsingException">
  715. <summary>
  716. Indicates an error during parsing. In most cases, unexpected token.
  717. </summary>
  718. </member>
  719. <member name="T:ClosedXML.Parser.ReferenceArea">
  720. <summary>
  721. Due to frequency of an area in formulas, the grammar has a token that represents
  722. an area in a sheet. This is the DTO from parser to engine. Two corners make an area
  723. for A1 notation, but not for R1C1 (has several edge cases).
  724. </summary>
  725. </member>
  726. <member name="P:ClosedXML.Parser.ReferenceArea.First">
  727. <summary>
  728. First reference. First in terms of position in formula, not position
  729. in sheet.
  730. </summary>
  731. </member>
  732. <member name="P:ClosedXML.Parser.ReferenceArea.Second">
  733. <summary>
  734. Second reference. Second in terms of position in formula, not position
  735. in sheet. If area was specified using only one cell, the value is
  736. same as <see cref="P:ClosedXML.Parser.ReferenceArea.First"/>.
  737. </summary>
  738. </member>
  739. <member name="P:ClosedXML.Parser.ReferenceArea.Style">
  740. <summary>
  741. Semantic style of reference.
  742. </summary>
  743. </member>
  744. <member name="P:ClosedXML.Parser.ReferenceArea.IsRowSpan">
  745. <summary>
  746. Is area a row span (e.g. <c>$5:7</c> in A1 or <c>R[7]</c>, <c>R7:R[9]</c>)?
  747. </summary>
  748. </member>
  749. <member name="P:ClosedXML.Parser.ReferenceArea.IsColSpan">
  750. <summary>
  751. Is area a col span (e.g. <c>$C:Z</c> in A1 or <c>C[7]</c>, <c>C7:C[9]</c>)?
  752. </summary>
  753. </member>
  754. <member name="M:ClosedXML.Parser.ReferenceArea.#ctor(ClosedXML.Parser.RowCol,ClosedXML.Parser.RowCol)">
  755. <summary>
  756. Create a reference symbol using the two <see cref="T:ClosedXML.Parser.RowCol"/> (e.g.
  757. <c>A1:B2</c>) or two columns (e.g. <c>A:D</c>) or two rows (e.g.
  758. <c>7:8</c>).
  759. </summary>
  760. </member>
  761. <member name="M:ClosedXML.Parser.ReferenceArea.#ctor(ClosedXML.Parser.RowCol)">
  762. <summary>
  763. Create an area for a single reference.
  764. </summary>
  765. </member>
  766. <member name="M:ClosedXML.Parser.ReferenceArea.#ctor(ClosedXML.Parser.ReferenceAxisType,System.Int32,ClosedXML.Parser.ReferenceAxisType,System.Int32,ClosedXML.Parser.ReferenceStyle)">
  767. <summary>
  768. Create a new area from a single <see cref="T:ClosedXML.Parser.RowCol"/>.
  769. </summary>
  770. <param name="rowType">Row axis type of a reference.</param>
  771. <param name="rowPosition">Row position.</param>
  772. <param name="columnType">Column axis type of a reference.</param>
  773. <param name="columnPosition">Column position.</param>
  774. <param name="style">Semantic of the reference.</param>
  775. </member>
  776. <member name="M:ClosedXML.Parser.ReferenceArea.#ctor(System.Int32,System.Int32,ClosedXML.Parser.ReferenceStyle)">
  777. <summary>
  778. Create a new area from a single row/column intersection.
  779. </summary>
  780. <param name="rowPosition"><see cref="F:ClosedXML.Parser.ReferenceAxisType.Relative"/> row.</param>
  781. <param name="columnPosition"><see cref="F:ClosedXML.Parser.ReferenceAxisType.Relative"/> column.</param>
  782. <param name="style">Semantic of the reference.</param>
  783. </member>
  784. <member name="M:ClosedXML.Parser.ReferenceArea.GetDisplayStringA1">
  785. <summary>
  786. Render area in A1 notation. The content must be a valid content
  787. from A1 token. If both references are same, only one is converted
  788. to display string.
  789. </summary>
  790. </member>
  791. <member name="M:ClosedXML.Parser.ReferenceArea.GetDisplayStringR1C1">
  792. <summary>
  793. Render area in R1C1 notation. The content must be a valid content
  794. from R1C1 token. If both references are same, only one is converted
  795. to display string.
  796. </summary>
  797. </member>
  798. <member name="M:ClosedXML.Parser.ReferenceArea.ToR1C1(System.Int32,System.Int32)">
  799. <summary>
  800. Convert A1 reference to R1C1.
  801. </summary>
  802. <remarks>Assumes reference is in A1.</remarks>
  803. </member>
  804. <member name="M:ClosedXML.Parser.ReferenceArea.ToA1OrError(System.Int32,System.Int32)">
  805. <summary>
  806. Convert R1C1 reference to A1.
  807. </summary>
  808. <remarks>Assumes reference is in R1C1.</remarks>
  809. </member>
  810. <member name="M:ClosedXML.Parser.ReferenceArea.AppendA1(System.Text.StringBuilder)">
  811. <summary>
  812. Get reference in A1 notation.
  813. </summary>
  814. <remarks>Assumes reference is in A1.</remarks>
  815. </member>
  816. <member name="M:ClosedXML.Parser.ReferenceArea.AppendR1C1(System.Text.StringBuilder)">
  817. <summary>
  818. Get reference in R1C1 notation.
  819. </summary>
  820. <remarks>Assumes reference is in R1C1.</remarks>
  821. </member>
  822. <member name="T:ClosedXML.Parser.ReferenceAxisType">
  823. <summary>
  824. The type of content stored in a row or column number of a reference.
  825. </summary>
  826. </member>
  827. <member name="F:ClosedXML.Parser.ReferenceAxisType.Relative">
  828. <summary>
  829. Axis is relative. E.g. <c>A5</c> for A1, <c>R[-3]</c> for R1C1.
  830. </summary>
  831. <remarks>Keep 0, so default <c>RowCol</c> is <em>A1</em>.</remarks>
  832. </member>
  833. <member name="F:ClosedXML.Parser.ReferenceAxisType.Absolute">
  834. <summary>
  835. Units are absolute. E.g. <c>$A$5</c> for A1, <c>R8C5</c> for R1C1.
  836. </summary>
  837. </member>
  838. <member name="F:ClosedXML.Parser.ReferenceAxisType.None">
  839. <summary>
  840. <para>
  841. The reference axis (row or column) is not specified for reference.
  842. Generally, it means whole axis is used. If the type is <see cref="F:ClosedXML.Parser.ReferenceAxisType.None"/>,
  843. the value is ignored, but should be 0.
  844. </para>
  845. <para>
  846. Examples:
  847. <list type="bullet">
  848. <item><c>A:B</c> in A1 doesn't specify row.</item>
  849. <item><c>R2</c> in R1C1 doesn't specify column.</item>
  850. </list>
  851. </para>
  852. </summary>
  853. </member>
  854. <member name="T:ClosedXML.Parser.ReferenceParser">
  855. <summary>
  856. A utility class that parses various types of references.
  857. </summary>
  858. </member>
  859. <member name="M:ClosedXML.Parser.ReferenceParser.TryParseA1(System.String,System.String@,ClosedXML.Parser.ReferenceArea@)">
  860. <summary>
  861. <para>
  862. Try to parse <paramref name="text"/> as a sheet reference (<c>Sheet!A5</c>) or a local
  863. reference (<c>A1</c>). If the <paramref name="text"/> is a local reference, the output
  864. value of the <paramref name="sheetName"/> is <c>null</c>.
  865. </para>
  866. <para>
  867. Unlike the <see cref="M:ClosedXML.Parser.ReferenceParser.TryParseA1(System.String,ClosedXML.Parser.ReferenceArea@)"/> or <see cref="M:ClosedXML.Parser.ReferenceParser.TryParseSheetA1(System.String,System.String@,ClosedXML.Parser.ReferenceArea@)"/>,
  868. this method can parse both sheet reference or local reference.
  869. </para>
  870. </summary>
  871. <param name="text">Text to parse.</param>
  872. <param name="sheetName">The unescaped name of a sheet for sheet reference, <c>null</c> for local reference.</param>
  873. <param name="area">The parsed reference area.</param>
  874. <returns><c>true</c> if parsing was a success, <c>false</c> otherwise.</returns>
  875. </member>
  876. <member name="M:ClosedXML.Parser.ReferenceParser.TryParseA1(System.String,ClosedXML.Parser.ReferenceArea@)">
  877. <summary>
  878. Parses area reference in A1 form. The possibilities are
  879. <list type="bullet">
  880. <item>Cell (e.g. <c>F8</c>).</item>
  881. <item>Area (e.g. <c>B2:$D7</c>).</item>
  882. <item>Colspan (e.g. <c>$D:$G</c>).</item>
  883. <item>Rowspan (e.g. <c>14:$15</c>).</item>
  884. </list>
  885. Doesn't allow any whitespaces or extra values inside.
  886. </summary>
  887. <param name="text">Text to parse.</param>
  888. <param name="area">Parsed area.</param>
  889. <returns><c>true</c> if parsing was a success, <c>false</c> otherwise.</returns>
  890. </member>
  891. <member name="M:ClosedXML.Parser.ReferenceParser.ParseA1(System.String)">
  892. <summary>
  893. Parses area reference in A1 form. The possibilities are
  894. <list type="bullet">
  895. <item>Cell (e.g. <c>F8</c>).</item>
  896. <item>Area (e.g. <c>B2:$D7</c>).</item>
  897. <item>Colspan (e.g. <c>$D:$G</c>).</item>
  898. <item>Rowspan (e.g. <c>14:$15</c>).</item>
  899. </list>
  900. Doesn't allow any whitespaces or extra values inside.
  901. </summary>
  902. <exception cref="T:ClosedXML.Parser.ParsingException">Invalid input.</exception>
  903. </member>
  904. <member name="M:ClosedXML.Parser.ReferenceParser.TryParseSheetA1(System.String,System.String@,ClosedXML.Parser.ReferenceArea@)">
  905. <summary>
  906. Try to parse a A1 reference that has a sheet (e.g. <c>'Data values'!A$1:F10</c>).
  907. If <paramref name="text"/> contains only reference without a sheet or anything
  908. else (e.g. <c>A1</c>), return <c>false</c>.
  909. </summary>
  910. <remarks>
  911. The method doesn't accept
  912. <list type="bullet">
  913. <item>Sheet names, e.g. <c>Sheet!name</c>.</item>
  914. <item>External sheet references, e.g. <c>[1]Sheet!A1</c>.</item>
  915. <item>Sheet errors, e.g. <c>Sheet5!$REF!</c>.</item>
  916. </list>
  917. </remarks>
  918. <param name="text">Text to parse.</param>
  919. <param name="sheetName">Name of the sheet, unescaped (e.g. the sheetName will contain <c>Jane's</c> for <c>'Jane''s'!A1</c>).</param>
  920. <param name="area">Parsed reference.</param>
  921. <returns><c>true</c> if parsing was a success, <c>false</c> otherwise.</returns>
  922. </member>
  923. <member name="M:ClosedXML.Parser.ReferenceParser.TryParseName(System.String,System.String@,System.String@)">
  924. <summary>
  925. <para>
  926. Try to parse <paramref name="text"/> as a name (e.g. <c>Name</c>) or a sheet name
  927. (<c>Sheet!Name</c>). If the <paramref name="text"/> is only a name, the output value of the
  928. <paramref name="sheetName"/> is <c>null</c>.
  929. </para>
  930. </summary>
  931. <param name="text">Text to parse.</param>
  932. <param name="sheetName">The unescaped name of a sheet for sheet name, <c>null</c> for a name.</param>
  933. <param name="name">The parsed name.</param>
  934. <returns><c>true</c> if parsing was a success, <c>false</c> otherwise.</returns>
  935. </member>
  936. <member name="M:ClosedXML.Parser.ReferenceParser.TryParseSheetName(System.String,System.String@,System.String@)">
  937. <summary>
  938. Try to parse a text as a sheet name (e.g. <c>Sheet!Name</c>). Doesn't accept pure name
  939. without sheet (e.g. <c>name</c>).
  940. </summary>
  941. <param name="text">Text to parse.</param>
  942. <param name="sheetName">Parsed sheet name, unescaped.</param>
  943. <param name="name">Parsed defined name.</param>
  944. <returns><c>true</c> if parsing was a success, <c>false</c> otherwise.</returns>
  945. </member>
  946. <member name="T:ClosedXML.Parser.ReferenceStyle">
  947. <summary>
  948. Style of referencing areas in a worksheet.
  949. </summary>
  950. </member>
  951. <member name="F:ClosedXML.Parser.ReferenceStyle.A1">
  952. <summary>
  953. The reference (<see cref="T:ClosedXML.Parser.ReferenceArea"/> or <see cref="T:ClosedXML.Parser.RowCol"/>)
  954. uses <em>A1</em> semantic. Even relative references start from
  955. <c>[1,1]</c>, but relative references move when cells move.
  956. </summary>
  957. </member>
  958. <member name="F:ClosedXML.Parser.ReferenceStyle.R1C1">
  959. <summary>
  960. The reference (<see cref="T:ClosedXML.Parser.ReferenceArea"/> or <see cref="T:ClosedXML.Parser.RowCol"/>)
  961. uses <em>R1C1</em> semantic. Relative references are relative to
  962. the cell that contains the reference, not <c>[1,1]</c>.
  963. </summary>
  964. </member>
  965. <member name="T:ClosedXML.Parser.RefModVisitor">
  966. <summary>
  967. It's designed to allow modifications of references, e.g. renaming, moving references
  968. and so on. Just inherit it and override one of <c>virtual Modify*</c> methods.
  969. </summary>
  970. </member>
  971. <member name="M:ClosedXML.Parser.RefModVisitor.LogicalValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Boolean)">
  972. <inheritdoc />
  973. </member>
  974. <member name="M:ClosedXML.Parser.RefModVisitor.NumberValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Double)">
  975. <inheritdoc />
  976. </member>
  977. <member name="M:ClosedXML.Parser.RefModVisitor.TextValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  978. <inheritdoc />
  979. </member>
  980. <member name="M:ClosedXML.Parser.RefModVisitor.ErrorValue(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char})">
  981. <inheritdoc />
  982. </member>
  983. <member name="M:ClosedXML.Parser.RefModVisitor.ArrayNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.Int32,System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  984. <inheritdoc />
  985. </member>
  986. <member name="M:ClosedXML.Parser.RefModVisitor.BlankNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange)">
  987. <inheritdoc />
  988. </member>
  989. <member name="M:ClosedXML.Parser.RefModVisitor.LogicalNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Boolean)">
  990. <inheritdoc />
  991. </member>
  992. <member name="M:ClosedXML.Parser.RefModVisitor.ErrorNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char})">
  993. <inheritdoc />
  994. </member>
  995. <member name="M:ClosedXML.Parser.RefModVisitor.NumberNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Double)">
  996. <inheritdoc />
  997. </member>
  998. <member name="M:ClosedXML.Parser.RefModVisitor.TextNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  999. <inheritdoc />
  1000. </member>
  1001. <member name="M:ClosedXML.Parser.RefModVisitor.Reference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.ReferenceArea)">
  1002. <inheritdoc />
  1003. </member>
  1004. <member name="M:ClosedXML.Parser.RefModVisitor.SheetReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,ClosedXML.Parser.ReferenceArea)">
  1005. <inheritdoc />
  1006. </member>
  1007. <member name="M:ClosedXML.Parser.RefModVisitor.BangReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.ReferenceArea)">
  1008. <inheritdoc />
  1009. </member>
  1010. <member name="M:ClosedXML.Parser.RefModVisitor.Reference3D(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,System.String,ClosedXML.Parser.ReferenceArea)">
  1011. <inheritdoc />
  1012. </member>
  1013. <member name="M:ClosedXML.Parser.RefModVisitor.ExternalSheetReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,ClosedXML.Parser.ReferenceArea)">
  1014. <inheritdoc />
  1015. </member>
  1016. <member name="M:ClosedXML.Parser.RefModVisitor.ExternalReference3D(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.String,ClosedXML.Parser.ReferenceArea)">
  1017. <inheritdoc />
  1018. </member>
  1019. <member name="M:ClosedXML.Parser.RefModVisitor.Function(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  1020. <inheritdoc />
  1021. </member>
  1022. <member name="M:ClosedXML.Parser.RefModVisitor.Function(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  1023. <inheritdoc />
  1024. </member>
  1025. <member name="M:ClosedXML.Parser.RefModVisitor.ExternalFunction(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  1026. <inheritdoc />
  1027. </member>
  1028. <member name="M:ClosedXML.Parser.RefModVisitor.ExternalFunction(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.ReadOnlySpan{System.Char},System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  1029. <inheritdoc />
  1030. </member>
  1031. <member name="M:ClosedXML.Parser.RefModVisitor.CellFunction(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.RowCol,System.Collections.Generic.IReadOnlyList{ClosedXML.Parser.TransformedSymbol})">
  1032. <inheritdoc />
  1033. </member>
  1034. <member name="M:ClosedXML.Parser.RefModVisitor.StructureReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  1035. <inheritdoc />
  1036. </member>
  1037. <member name="M:ClosedXML.Parser.RefModVisitor.StructureReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  1038. <inheritdoc />
  1039. </member>
  1040. <member name="M:ClosedXML.Parser.RefModVisitor.ExternalStructureReference(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,ClosedXML.Parser.StructuredReferenceArea,System.String,System.String)">
  1041. <inheritdoc />
  1042. </member>
  1043. <member name="M:ClosedXML.Parser.RefModVisitor.Name(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  1044. <inheritdoc />
  1045. </member>
  1046. <member name="M:ClosedXML.Parser.RefModVisitor.SheetName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String,System.String)">
  1047. <inheritdoc />
  1048. </member>
  1049. <member name="M:ClosedXML.Parser.RefModVisitor.BangName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.String)">
  1050. <inheritdoc />
  1051. </member>
  1052. <member name="M:ClosedXML.Parser.RefModVisitor.ExternalName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String)">
  1053. <inheritdoc />
  1054. </member>
  1055. <member name="M:ClosedXML.Parser.RefModVisitor.ExternalSheetName(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,System.Int32,System.String,System.String)">
  1056. <inheritdoc />
  1057. </member>
  1058. <member name="M:ClosedXML.Parser.RefModVisitor.BinaryNode(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.BinaryOperation,ClosedXML.Parser.TransformedSymbol,ClosedXML.Parser.TransformedSymbol)">
  1059. <inheritdoc />
  1060. </member>
  1061. <member name="M:ClosedXML.Parser.RefModVisitor.Unary(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.UnaryOperation,ClosedXML.Parser.TransformedSymbol)">
  1062. <inheritdoc />
  1063. </member>
  1064. <member name="M:ClosedXML.Parser.RefModVisitor.Nested(ClosedXML.Parser.ModContext,ClosedXML.Parser.SymbolRange,ClosedXML.Parser.TransformedSymbol)">
  1065. <inheritdoc />
  1066. </member>
  1067. <member name="M:ClosedXML.Parser.RefModVisitor.ModifySheet(ClosedXML.Parser.ModContext,System.String)">
  1068. <summary>
  1069. An extension to modify sheet name, e.g. rename.
  1070. </summary>
  1071. <param name="ctx">The transformation context.</param>
  1072. <param name="sheetName">Original sheet name.</param>
  1073. <returns>New sheet name. If null, it indicates sheet has been deleted and should be replaced with <c>#REF!</c></returns>
  1074. </member>
  1075. <member name="M:ClosedXML.Parser.RefModVisitor.ModifyTable(ClosedXML.Parser.ModContext,System.String)">
  1076. <summary>
  1077. Modify reference to a cell.
  1078. </summary>
  1079. <param name="ctx">The origin of formula.</param>
  1080. <param name="table">Original name of a table.</param>
  1081. <returns>Modified name of a table or null if <c>#REF!</c>.</returns>
  1082. </member>
  1083. <member name="M:ClosedXML.Parser.RefModVisitor.ModifyFunction(ClosedXML.Parser.ModContext,System.ReadOnlySpan{System.Char})">
  1084. <summary>
  1085. An extension to modify name of a function. Doesn't modify the sheet/external functions.
  1086. </summary>
  1087. <param name="ctx">The transformation context.</param>
  1088. <param name="functionName">Original name of function.</param>
  1089. <returns>New name of a function.</returns>
  1090. </member>
  1091. <member name="M:ClosedXML.Parser.RefModVisitor.ModifyRef(ClosedXML.Parser.ModContext,ClosedXML.Parser.ReferenceArea)">
  1092. <summary>
  1093. Modify reference to a cell. This method is called for every place where is a ref and is
  1094. mostly intended to change reference style.
  1095. </summary>
  1096. <param name="ctx">The origin of formula.</param>
  1097. <param name="reference">Area reference.</param>
  1098. <returns>Modified reference or null if <c>#REF!</c>.</returns>
  1099. </member>
  1100. <member name="M:ClosedXML.Parser.RefModVisitor.ModifyCellFunction(ClosedXML.Parser.ModContext,ClosedXML.Parser.RowCol)">
  1101. <summary>
  1102. Modify reference to a cell function.
  1103. </summary>
  1104. <param name="ctx">The transformation context.</param>
  1105. <param name="cell">Original cell containing function.</param>
  1106. <returns>Modified reference or null if <c>#REF!</c>.</returns>
  1107. </member>
  1108. <member name="M:ClosedXML.Parser.Rolex.RolexLexer.GetTokensA1(System.ReadOnlySpan{System.Char})">
  1109. <summary>
  1110. Get all tokens for a formula. Use A1 semantic. If there is an error, add token with an error symbol at the end or EOF token at the end.
  1111. </summary>
  1112. <param name="formula">Formula to parse.</param>
  1113. </member>
  1114. <member name="M:ClosedXML.Parser.Rolex.RolexLexer.GetTokensR1C1(System.ReadOnlySpan{System.Char})">
  1115. <summary>
  1116. Get all tokens for a formula. Use R1C1 semantic. If there is an error, add token with an error symbol at the end or EOF token at the end.
  1117. </summary>
  1118. <param name="formula">Formula to parse.</param>
  1119. </member>
  1120. <member name="T:ClosedXML.Parser.Rolex.TableTokenizer">
  1121. <summary>
  1122. A class required by a Rolex tool. Never used.
  1123. </summary>
  1124. </member>
  1125. <member name="T:ClosedXML.Parser.RowCol">
  1126. <summary>
  1127. <para>
  1128. One endpoint of a reference defined by row and column axis. It can be
  1129. <list type="bullet">
  1130. <item>
  1131. A single cell that is an intersection of row and a column
  1132. </item>
  1133. <item>
  1134. An entire row, e.g. <c><em>A</em>:B</c> or <c><em>R5</em>:R10</c>.
  1135. </item>
  1136. <item>
  1137. An entire column, e.g. <c><em>7</em>:14</c> or <c><em>C7</em>:C10</c>.
  1138. </item>
  1139. </list>
  1140. The content of values and thus their interpretation depends on the
  1141. <see cref="T:ClosedXML.Parser.ReferenceArea"/> reference style, e.g. column 14 with
  1142. <see cref="F:ClosedXML.Parser.ReferenceAxisType.Relative"/> can indicate <c>R[14]</c> or <c>X14</c> for A1
  1143. style.
  1144. </para>
  1145. <para>
  1146. Not all combinations are valid and the content of the reference corresponds
  1147. to a valid token in expected reference style (e.g. in R1C1, <c>R</c> is
  1148. a valid standalone reference, but there is no such possibility for A1).
  1149. </para>
  1150. </summary>
  1151. </member>
  1152. <member name="P:ClosedXML.Parser.RowCol.ColumnType">
  1153. <summary>
  1154. How to interpret the <see cref="P:ClosedXML.Parser.RowCol.ColumnValue"/> value.
  1155. </summary>
  1156. </member>
  1157. <member name="P:ClosedXML.Parser.RowCol.ColumnValue">
  1158. <summary>
  1159. Position of a column.
  1160. </summary>
  1161. </member>
  1162. <member name="P:ClosedXML.Parser.RowCol.RowType">
  1163. <summary>
  1164. How to interpret the <see cref="P:ClosedXML.Parser.RowCol.RowValue"/> value.
  1165. </summary>
  1166. </member>
  1167. <member name="P:ClosedXML.Parser.RowCol.RowValue">
  1168. <summary>
  1169. Position of a row.
  1170. </summary>
  1171. </member>
  1172. <member name="P:ClosedXML.Parser.RowCol.IsA1">
  1173. <summary>
  1174. Does <c>RowCol</c> use <em>A1</em> semantic?
  1175. </summary>
  1176. </member>
  1177. <member name="P:ClosedXML.Parser.RowCol.IsR1C1">
  1178. <summary>
  1179. Does <c>RowCol</c> use <em>R1C1</em> semantic?
  1180. </summary>
  1181. </member>
  1182. <member name="P:ClosedXML.Parser.RowCol.Style">
  1183. <summary>
  1184. Reference style of the <c>RowCol</c>.
  1185. </summary>
  1186. </member>
  1187. <member name="P:ClosedXML.Parser.RowCol.IsRow">
  1188. <summary>
  1189. Is RowCol a part (start or end) of row span?
  1190. </summary>
  1191. </member>
  1192. <member name="P:ClosedXML.Parser.RowCol.IsColumn">
  1193. <summary>
  1194. Is RowCol a part (start or end) of column span?
  1195. </summary>
  1196. </member>
  1197. <member name="M:ClosedXML.Parser.RowCol.#ctor(ClosedXML.Parser.ReferenceAxisType,System.Int32,ClosedXML.Parser.ReferenceAxisType,System.Int32,ClosedXML.Parser.ReferenceStyle)">
  1198. <summary>
  1199. Create a new <see cref="T:ClosedXML.Parser.RowCol"/> with both row and columns specified.
  1200. </summary>
  1201. <param name="rowType">The type used to interpret the row position.</param>
  1202. <param name="rowValue">The value for the row position.</param>
  1203. <param name="columnType">The type used to interpret the column position.</param>
  1204. <param name="columnValue">The value for the column position.</param>
  1205. <param name="style">Semantic of the reference.</param>
  1206. </member>
  1207. <member name="M:ClosedXML.Parser.RowCol.#ctor(System.Boolean,System.Int32,System.Boolean,System.Int32,ClosedXML.Parser.ReferenceStyle)">
  1208. <summary>
  1209. Create a new <see cref="T:ClosedXML.Parser.RowCol"/> with both row and columns specified.
  1210. </summary>
  1211. <param name="rowAbs">Is the row reference absolute? If false, then relative.</param>
  1212. <param name="rowValue">The value for the row position.</param>
  1213. <param name="colAbs">Is the column reference absolute? If false, then relative.</param>
  1214. <param name="columnValue">The value for the column position.</param>
  1215. <param name="style">Semantic of the reference.</param>
  1216. </member>
  1217. <member name="M:ClosedXML.Parser.RowCol.#ctor(System.Int32,System.Int32,ClosedXML.Parser.ReferenceStyle)">
  1218. <summary>
  1219. Create a new <see cref="T:ClosedXML.Parser.RowCol"/> with both row and columns specified
  1220. with relative values. Used mostly for A1 style.
  1221. </summary>
  1222. <param name="row">The relative position of the row.</param>
  1223. <param name="column">The relative position of the column.</param>
  1224. <param name="style">Semantic of the reference.</param>
  1225. </member>
  1226. <member name="M:ClosedXML.Parser.RowCol.op_Equality(ClosedXML.Parser.RowCol,ClosedXML.Parser.RowCol)">
  1227. <summary>
  1228. Compares two <see cref="T:ClosedXML.Parser.RowCol"/> objects by value. The result specifies whether
  1229. all properties of the two <see cref="T:ClosedXML.Parser.RowCol"/> objects are equal.
  1230. </summary>
  1231. </member>
  1232. <member name="M:ClosedXML.Parser.RowCol.op_Inequality(ClosedXML.Parser.RowCol,ClosedXML.Parser.RowCol)">
  1233. <summary>
  1234. Compares two <see cref="T:ClosedXML.Parser.RowCol"/> objects by value. The result specifies whether
  1235. any property of the two <see cref="T:ClosedXML.Parser.RowCol"/> objects is not equal.
  1236. </summary>
  1237. </member>
  1238. <member name="M:ClosedXML.Parser.RowCol.GetDisplayStringA1">
  1239. <summary>
  1240. Get a reference in <em>A1</em> notation.
  1241. </summary>
  1242. <exception cref="T:System.InvalidOperationException">When <c>RowCol</c> doesn't use <em>A1</em> semantic.</exception>
  1243. </member>
  1244. <member name="M:ClosedXML.Parser.RowCol.GetDisplayStringR1C1">
  1245. <summary>
  1246. Get a reference in <em>R1C1</em> notation.
  1247. </summary>
  1248. <exception cref="T:System.InvalidOperationException">When <c>RowCol</c> doesn't use <em>R1C1</em> semantic.</exception>
  1249. </member>
  1250. <member name="M:ClosedXML.Parser.RowCol.ToR1C1(System.Int32,System.Int32)">
  1251. <summary>
  1252. Convert <c>RowCol</c> to <em>R1C1</em>.
  1253. </summary>
  1254. <remarks>If <c>RowCol</c> already is in <em>R1C1</em>, return it directly.</remarks>
  1255. <param name="anchorRow">A row coordinate that should be used as an anchor for relative R1C1 reference.</param>
  1256. <param name="anchorCol">A column coordinate that should be used as an anchor for relative R1C1 reference.</param>
  1257. <returns>RowCol with R1C1 semantic.</returns>
  1258. <exception cref="T:System.ArgumentOutOfRangeException">Row or col is out of valid row or column number.</exception>
  1259. </member>
  1260. <member name="M:ClosedXML.Parser.RowCol.ToA1(System.Int32,System.Int32)">
  1261. <summary>
  1262. Convert <c>RowCol</c> to <em>A1</em>.
  1263. </summary>
  1264. <remarks>
  1265. If <c>RowCol</c> already is in <em>A1</em>, return it directly. If converted <c>RowCol</c>
  1266. is out of sheet bounds, loop it.
  1267. </remarks>
  1268. <param name="anchorRow">A row coordinate that should be used as an anchor for relative <em>R1C1</em> reference.</param>
  1269. <param name="anchorCol">A column coordinate that should be used as an anchor for relative <em>R1C1</em> reference.</param>
  1270. <returns>RowCol with R1C1 semantic.</returns>
  1271. <exception cref="T:System.ArgumentOutOfRangeException">Row or col is out of valid row or column number.</exception>
  1272. </member>
  1273. <member name="M:ClosedXML.Parser.RowCol.AppendA1(System.Text.StringBuilder)">
  1274. <inheritdoc cref="M:ClosedXML.Parser.RowCol.GetDisplayStringA1"/>
  1275. <param name="sb">String buffer where to write the output.</param>
  1276. <exception cref="T:System.InvalidOperationException">When <c>RowCol</c> is not in <em>A1</em> notation.</exception>
  1277. </member>
  1278. <member name="M:ClosedXML.Parser.RowCol.AppendR1C1(System.Text.StringBuilder)">
  1279. <inheritdoc cref="M:ClosedXML.Parser.RowCol.GetDisplayStringR1C1"/>
  1280. <param name="sb">String buffer where to write the output.</param>
  1281. <exception cref="T:System.InvalidOperationException">When <c>RowCol</c> is not in <em>A1</em> notation.</exception>
  1282. </member>
  1283. <member name="M:ClosedXML.Parser.RowCol.Equals(System.Object)">
  1284. <summary>
  1285. Check whether the <paramref name="obj"/> is of type <see cref="T:ClosedXML.Parser.RowCol"/>
  1286. and all values are same as this one.
  1287. </summary>
  1288. </member>
  1289. <member name="M:ClosedXML.Parser.RowCol.Equals(ClosedXML.Parser.RowCol)">
  1290. <summary>
  1291. Check whether the all values of <paramref name="other"/> are same as
  1292. this one.
  1293. </summary>
  1294. </member>
  1295. <member name="M:ClosedXML.Parser.RowCol.GetHashCode">
  1296. <summary>
  1297. Returns a hash code for this <see cref="T:ClosedXML.Parser.RowCol"/>.
  1298. </summary>
  1299. </member>
  1300. <member name="T:ClosedXML.Parser.StringBuilderExtensions">
  1301. <summary>
  1302. Extension methods for building formulas.
  1303. </summary>
  1304. </member>
  1305. <member name="M:ClosedXML.Parser.StringBuilderExtensions.Append(System.Text.StringBuilder,System.ReadOnlySpan{System.Char})">
  1306. <summary>
  1307. Compatibility method for NETStandard 2.0, which doesn't have methods with <c>Span</c> arguments.
  1308. </summary>
  1309. </member>
  1310. <member name="T:ClosedXML.Parser.StructuredReferenceArea">
  1311. <summary>
  1312. Structure reference is basically a set of cells in an area of an intersection between a range of columns
  1313. in a table and a vertical range. This enum represents possible values. Thanks to the pattern of a structure
  1314. reference token, the vertical range of a formula is always continuous (i.e. no <c>Headers</c> and <c>Totals</c>
  1315. together).
  1316. </summary>
  1317. <remarks>
  1318. The documentation calls it *Item specifier* and grammar *keywords*. Both rather unintuitive names, so *area*
  1319. is used instead.
  1320. </remarks>
  1321. </member>
  1322. <member name="F:ClosedXML.Parser.StructuredReferenceArea.None">
  1323. <summary>
  1324. Nothing was specified in the structure reference. Should have same impact as <see cref="F:ClosedXML.Parser.StructuredReferenceArea.Data"/>.
  1325. </summary>
  1326. </member>
  1327. <member name="F:ClosedXML.Parser.StructuredReferenceArea.Data">
  1328. <summary>
  1329. <c>[#Data]</c> - only data cells of a table, without headers or totals.
  1330. </summary>
  1331. </member>
  1332. <member name="F:ClosedXML.Parser.StructuredReferenceArea.Headers">
  1333. <summary>
  1334. <c>[#Headers]</c> - only header rows of a table, if it exists. If there isn't header row, <c>#REF!</c>.
  1335. </summary>
  1336. </member>
  1337. <member name="F:ClosedXML.Parser.StructuredReferenceArea.Totals">
  1338. <summary>
  1339. <c>[#Totals]</c> - only totals rows of a table, if it exists. If there isn't totals row, <c>#REF!</c>.
  1340. </summary>
  1341. </member>
  1342. <member name="F:ClosedXML.Parser.StructuredReferenceArea.All">
  1343. <summary>
  1344. <c>[#All]</c> - all cells of a table.
  1345. </summary>
  1346. </member>
  1347. <member name="F:ClosedXML.Parser.StructuredReferenceArea.ThisRow">
  1348. <summary>
  1349. <c>[#This Row]</c> - only the same data row as the referencing cell. <c>#VALUE!</c> if not on a data row
  1350. (e.g. headers or totals) or out of a table.
  1351. </summary>
  1352. </member>
  1353. <member name="T:ClosedXML.Parser.SymbolRange">
  1354. <summary>
  1355. A range of a symbol in formula text.
  1356. </summary>
  1357. </member>
  1358. <member name="M:ClosedXML.Parser.SymbolRange.#ctor(System.Int32,System.Int32)">
  1359. <summary>
  1360. Create a substring of a symbol.
  1361. </summary>
  1362. </member>
  1363. <member name="P:ClosedXML.Parser.SymbolRange.Start">
  1364. <summary>
  1365. Start index of symbol in formula text.
  1366. </summary>
  1367. </member>
  1368. <member name="P:ClosedXML.Parser.SymbolRange.End">
  1369. <summary>
  1370. End index of symbol in formula text. Can be outside of text bounds, if symbol ends at the
  1371. last char of formula.
  1372. </summary>
  1373. </member>
  1374. <member name="P:ClosedXML.Parser.SymbolRange.Length">
  1375. <summary>
  1376. Length of a symbol.
  1377. </summary>
  1378. </member>
  1379. <member name="M:ClosedXML.Parser.SymbolRange.ToString">
  1380. <summary>
  1381. Get range indexes.
  1382. </summary>
  1383. </member>
  1384. <member name="T:ClosedXML.Parser.Token">
  1385. <summary>
  1386. A token for a formula input.
  1387. </summary>
  1388. </member>
  1389. <member name="F:ClosedXML.Parser.Token.ErrorSymbolId">
  1390. <summary>
  1391. An error symbol id.
  1392. </summary>
  1393. </member>
  1394. <member name="F:ClosedXML.Parser.Token.EofSymbolId">
  1395. <summary>
  1396. An symbol id for end of file. Mostly for compatibility with ANTLR.
  1397. </summary>
  1398. </member>
  1399. <member name="F:ClosedXML.Parser.Token.SymbolId">
  1400. <summary>
  1401. A token ID or TokenType. Non-negative integer. The values are from Antlr grammar, starting with 1.
  1402. See <c>FormulaLexer.tokens</c>. The value -1 indicates an error and unrecognized token and is always
  1403. last token.
  1404. </summary>
  1405. </member>
  1406. <member name="F:ClosedXML.Parser.Token.StartIndex">
  1407. <summary>
  1408. The starting index of a token, in code units (=chars).
  1409. </summary>
  1410. </member>
  1411. <member name="F:ClosedXML.Parser.Token.Length">
  1412. <summary>
  1413. Length of a token in code units (=chars). For non-error tokens, must be at least 1. Ignore for error token.
  1414. </summary>
  1415. </member>
  1416. <member name="M:ClosedXML.Parser.TokenParser.ParseSingleSheetPrefix(System.ReadOnlySpan{System.Char},System.Nullable{System.Int32}@,System.String@)">
  1417. <summary>
  1418. Parse <see cref="F:ClosedXML.Parser.Token.SINGLE_SHEET_PREFIX"/> token.
  1419. </summary>
  1420. </member>
  1421. <member name="M:ClosedXML.Parser.TokenParser.ParseSheetRangePrefix(System.ReadOnlySpan{System.Char},System.Nullable{System.Int32}@,System.String@,System.String@)">
  1422. <summary>
  1423. Parse token <see cref="F:ClosedXML.Parser.Token.SHEET_RANGE_PREFIX"/>
  1424. </summary>
  1425. </member>
  1426. <member name="M:ClosedXML.Parser.TokenParser.ParseR1C1Reference(System.ReadOnlySpan{System.Char})">
  1427. <summary>
  1428. Parse <c>A1_REFERENCE</c> token in R1C1 mode.
  1429. </summary>
  1430. <param name="token">The span of a token.</param>
  1431. </member>
  1432. <member name="M:ClosedXML.Parser.TokenParser.ReadR1C1Axis(System.ReadOnlySpan{System.Char},System.Int32@)">
  1433. <summary>
  1434. Read the axis value. Can work for row or column.
  1435. </summary>
  1436. <param name="token">The span of a token.</param>
  1437. <param name="currentIdx">Index where is <c>C</c>/<c>R</c>.</param>
  1438. </member>
  1439. <member name="M:ClosedXML.Parser.TokenParser.ParseA1Reference(System.ReadOnlySpan{System.Char})">
  1440. <summary>
  1441. Extract info about cell reference from a <c>A1_REFERENCE</c> token.
  1442. </summary>
  1443. </member>
  1444. <member name="M:ClosedXML.Parser.TokenParser.GetStructuredName(System.ReadOnlySpan{System.Char},System.Int32,System.String@)">
  1445. <summary>
  1446. Read a structured name until the end bracket or column
  1447. </summary>
  1448. <param name="input">Input span.</param>
  1449. <param name="startIdx">First index of expected name. It will either contain a bracket or first letter of column name.</param>
  1450. <param name="columnName">Parsed name.</param>
  1451. </member>
  1452. <member name="T:ClosedXML.Parser.TransformedSymbol">
  1453. <summary>
  1454. A symbol that represents a transformed symbol value. Should be used during AST transformation.
  1455. </summary>
  1456. </member>
  1457. <member name="F:ClosedXML.Parser.TransformedSymbol._transformedText">
  1458. <summary>
  1459. The text that replaced symbol or null, if there was no change.
  1460. </summary>
  1461. </member>
  1462. <member name="P:ClosedXML.Parser.TransformedSymbol.OriginalRange">
  1463. <summary>
  1464. Range of the symbol in original formula.
  1465. </summary>
  1466. </member>
  1467. <member name="P:ClosedXML.Parser.TransformedSymbol.Length">
  1468. <summary>
  1469. Length of the transformed symbol.
  1470. </summary>
  1471. </member>
  1472. <member name="M:ClosedXML.Parser.TransformedSymbol.ToText(System.String,ClosedXML.Parser.SymbolRange,System.String)">
  1473. <summary>
  1474. Create a symbol that is different from what was in the original formula.
  1475. </summary>
  1476. <param name="formula">Text of whole formula.</param>
  1477. <param name="range">Range of the symbol in the formula.</param>
  1478. <param name="transformedSymbol">The string of a transformed symbol.</param>
  1479. </member>
  1480. <member name="M:ClosedXML.Parser.TransformedSymbol.CopyOriginal(System.String,ClosedXML.Parser.SymbolRange)">
  1481. <summary>
  1482. Create a new symbol represented by a substring of an original formula. Generally used when
  1483. there is no modification of the symbol (i.e. just pass it as it is).
  1484. </summary>
  1485. <param name="formula">Text of whole formula.</param>
  1486. <param name="range">Range of the symbol in the formula.</param>
  1487. </member>
  1488. <member name="M:ClosedXML.Parser.TransformedSymbol.AsSpan">
  1489. <summary>
  1490. Get content of the symbol as a span. Doesn't allocate memory.
  1491. </summary>
  1492. </member>
  1493. <member name="M:ClosedXML.Parser.TransformedSymbol.ToString(System.ReadOnlySpan{System.Char})">
  1494. <summary>
  1495. Get symbol as a text with extra text at the end.
  1496. </summary>
  1497. <param name="append">Text to append at the end of the symbol text.</param>
  1498. </member>
  1499. <member name="M:ClosedXML.Parser.TransformedSymbol.ToString">
  1500. <summary>
  1501. Get symbol text representation.
  1502. </summary>
  1503. </member>
  1504. <member name="T:ClosedXML.Parser.UnaryOperation">
  1505. <summary>
  1506. Unary operations of a formula.
  1507. </summary>
  1508. <remarks>Range operations are always after number operations.</remarks>
  1509. </member>
  1510. <member name="F:ClosedXML.Parser.UnaryOperation.Plus">
  1511. <summary>Prefix plus operation.</summary>
  1512. </member>
  1513. <member name="F:ClosedXML.Parser.UnaryOperation.Minus">
  1514. <summary>Prefix minus operation.</summary>
  1515. </member>
  1516. <member name="F:ClosedXML.Parser.UnaryOperation.Percent">
  1517. <summary>Suffix percent operation.</summary>
  1518. </member>
  1519. <member name="F:ClosedXML.Parser.UnaryOperation.ImplicitIntersection">
  1520. <summary>Prefix range intersection operation.</summary>
  1521. </member>
  1522. <member name="F:ClosedXML.Parser.UnaryOperation.SpillRange">
  1523. <summary>Suffix range spill operation.</summary>
  1524. </member>
  1525. </members>
  1526. </doc>