PageRenderTime 37ms CodeModel.GetById 12ms RepoModel.GetById 0ms app.codeStats 1ms

/Dlls/Delta.Utilities.Xml.xml

#
XML | 790 lines | 785 code | 5 blank | 0 comment | 0 complexity | 44fa7f9a45d2032e47218d5c31e94384 MD5 | raw file
Possible License(s): Apache-2.0
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Delta.Utilities.Xml</name>
  5. </assembly>
  6. <members>
  7. <member name="T:Delta.Utilities.Xml.XmlNode">
  8. <summary>
  9. Our own XmlNode format which provides only required information and
  10. offers a couple of useful functions. The main idea is avoiding that the
  11. user handle complicated xml functions, instead giving a very simple
  12. class which wraps the properties and function we think are important
  13. and is presented in a very easy way to use.
  14. </summary>
  15. </member>
  16. <member name="M:Delta.Utilities.Xml.XmlNode.GetNamespaceName(System.String,System.String)">
  17. <summary>
  18. Helper method to construct NamespaceName from given
  19. namespaceName and nodeName.
  20. </summary>
  21. <param name="namespaceName">Namespace name</param>
  22. <param name="nodeName">Node name</param>
  23. <returns>Namespace name</returns>
  24. </member>
  25. <member name="M:Delta.Utilities.Xml.XmlNode.GetNamespaceName(System.Xml.Linq.XNamespace,System.String)">
  26. <summary>
  27. Helper method to construct NamespaceName from given
  28. namespace and nodeName.
  29. </summary>
  30. <param name="xNamespace">Namespace</param>
  31. <param name="nodeName">Node name</param>
  32. <returns>Namespace name</returns>
  33. </member>
  34. <member name="M:Delta.Utilities.Xml.XmlNode.FromFile(System.String)">
  35. <summary>
  36. Loads the XML file under the given path and returns the root node or
  37. 'null' if the loading fails. AutoSetNamespaceOnChildren is set to
  38. false.
  39. </summary>
  40. <param name="xmlFilePath">Xml file path</param>
  41. <returns>the root node or 'null' if the loading fails</returns>
  42. </member>
  43. <member name="M:Delta.Utilities.Xml.XmlNode.FromFile(System.String,System.Boolean,System.String@)">
  44. <summary>
  45. Loads the XML file under the given path and returns the root node or
  46. 'null' if the loading fails.
  47. </summary>
  48. <param name="xmlFilePath">Xml file path</param>
  49. <param name="autoSetNamespaceOnChildren">Flag if the namespace should
  50. be set to the children automatically.</param>
  51. <returns>the root node or 'null' if the loading fails</returns>
  52. </member>
  53. <member name="M:Delta.Utilities.Xml.XmlNode.FromSnippet(System.String)">
  54. <summary>
  55. Loads and Xml node from an Xml snippet.
  56. </summary>
  57. <param name="xmlAsText">Xml as text</param>
  58. <returns>Xml node</returns>
  59. </member>
  60. <member name="M:Delta.Utilities.Xml.XmlNode.FromSnippet(System.String,System.String@)">
  61. <summary>
  62. Loads and Xml node from an Xml snippet.
  63. </summary>
  64. <param name="xmlAsText">Xml as text</param>
  65. <param name="error">Error string if anything has gone wrong</param>
  66. <returns>Filled XmlNode from xmlAsText</returns>
  67. </member>
  68. <member name="M:Delta.Utilities.Xml.XmlNode.FromMemoryStream(System.IO.MemoryStream)">
  69. <summary>
  70. Helper method to load xml data from a memory stream, which must contain
  71. the same data as a saved xml file (see the Save() method). To load
  72. snippet strings use the FromSnippet method instead.
  73. </summary>
  74. <param name="xmlData">Xml data in a memory stream</param>
  75. <returns>Loaded XmlNode</returns>
  76. </member>
  77. <member name="F:Delta.Utilities.Xml.XmlNode.xNodeRoot">
  78. <summary>
  79. Main element that contain all the info related with the xml node.
  80. Be aware that from this variable we get all the information from
  81. the xml file we are working with.
  82. </summary>
  83. </member>
  84. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.Xml.Linq.XElement)">
  85. <summary>
  86. We only allow to create a XmlNode internally and we rely on
  87. XmlHelper to create it when necessary. As expected, to start off
  88. we assign a root node that contains everything we need.
  89. </summary>
  90. <param name="setNodeRoot">represents the root node</param>
  91. </member>
  92. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.Xml.Linq.XElement,System.Boolean)">
  93. <summary>
  94. We only allow to create a XmlNode internally and we rely on
  95. XmlHelper to create it when necessary. As expected, to start off
  96. we assign a root node that contains everything we need.
  97. </summary>
  98. <param name="setNodeRoot">represents the root node</param>
  99. <param name="autoSetNamespaceOnChildren">Flag if the namespace should
  100. be set to the children automatically.</param>
  101. </member>
  102. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.Xml.Linq.XElement,Delta.Utilities.Xml.XmlNode)">
  103. <summary>
  104. We only allow to create a XmlNode internally and we rely on
  105. XmlHelper to create it when necessary. As expected, to start off
  106. we assign a root node that contains everything we need.
  107. </summary>
  108. <param name="setNodeRoot">represents the root node</param>
  109. <param name="setParent">the parent node</param>
  110. </member>
  111. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.Xml.Linq.XElement,Delta.Utilities.Xml.XmlNode,System.Boolean)">
  112. <summary>
  113. We only allow to create a XmlNode internally and we rely on
  114. XmlHelper to create it when necessary. As expected, to start off
  115. we assign a root node that contains everything we need.
  116. </summary>
  117. <param name="setNodeRoot">represents the root node</param>
  118. <param name="setParent">the parent node</param>
  119. <param name="autoSetNamespaceOnChildren">Flag if the namespace should
  120. be set to the children automatically.</param>
  121. </member>
  122. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.String,System.String,System.Boolean)">
  123. <summary>
  124. Creates an XML root node with the given name, but no children yet.
  125. When createWithXmlHeader is true an Xml declaration is added at top!
  126. </summary>
  127. <param name="createWithXmlHeader">Create with xml header</param>
  128. <param name="setNamespace">Set namespace</param>
  129. <param name="setRootName">Set root node name</param>
  130. </member>
  131. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.Xml.Linq.XNamespace,System.String,System.Boolean)">
  132. <summary>
  133. Creates an XML root node with the given name, but no children yet.
  134. When createWithXmlHeader is true an Xml declaration is added at top!
  135. </summary>
  136. <param name="createWithXmlHeader">create with xml header</param>
  137. <param name="setNamespace">set namespace</param>
  138. <param name="setRootName">set root name</param>
  139. </member>
  140. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.String,System.Boolean)">
  141. <summary>
  142. Creates an XML root node with the given name, but no children yet.
  143. When createWithXmlHeader is true an Xml declaration is added at top!
  144. </summary>
  145. <param name="createWithXmlHeader">create with xml heater</param>
  146. <param name="setRootName">set root name</param>
  147. </member>
  148. <member name="M:Delta.Utilities.Xml.XmlNode.#ctor(System.String)">
  149. <summary>
  150. Create xml node root node with the given name (no xml header)
  151. </summary>
  152. <param name="setRootName">set root name</param>
  153. </member>
  154. <member name="M:Delta.Utilities.Xml.XmlNode.AddChild(System.String)">
  155. <summary>
  156. Adds a new child with given name and returns it to be filled.
  157. If ChildWillInheritNamespace is true, it will inherit the namespace of
  158. this node (Namespace part in given name will be ignored).
  159. </summary>
  160. <param name="name">Name for the new child</param>
  161. <returns>The newly added child as an XmlNode</returns>
  162. </member>
  163. <member name="M:Delta.Utilities.Xml.XmlNode.AddChild(System.String,System.String)">
  164. <summary>
  165. Adds a new child with given name and returns it to be filled.
  166. If ChildWillInheritNamespace is true, it will inherit the namespace of
  167. this node (Namespace part in given name will be ignored).
  168. </summary>
  169. <param name="name">Name</param>
  170. <param name="value">Value</param>
  171. <returns>The newly added child as an XmlNode</returns>
  172. </member>
  173. <member name="M:Delta.Utilities.Xml.XmlNode.AddChild(Delta.Utilities.Xml.XmlNode)">
  174. <summary>
  175. Add child from XmlNode. Note: This will create a copy of the XmlNode
  176. to make sure we do not modify the original XmlNode that could come
  177. from another tree or document.
  178. </summary>
  179. <param name="childNode">Child node we want to add</param>
  180. </member>
  181. <member name="M:Delta.Utilities.Xml.XmlNode.AddAttribute(System.String,System.String)">
  182. <summary>
  183. Add attribute
  184. </summary>
  185. <param name="name">name</param>
  186. <param name="value">value</param>
  187. </member>
  188. <member name="M:Delta.Utilities.Xml.XmlNode.AddAttribute(System.String,System.String,System.String)">
  189. <summary>
  190. Add attribute
  191. </summary>
  192. </member>
  193. <member name="M:Delta.Utilities.Xml.XmlNode.GetValueAs``1(``0)">
  194. <summary>
  195. Get value as any supported datatype that is passed to this generic
  196. method. Uses StringHelper.FromInvariantString to convert.
  197. </summary>
  198. <param name="defaultValue">Default value</param>
  199. <returns>Value string converted to type T</returns>
  200. </member>
  201. <member name="M:Delta.Utilities.Xml.XmlNode.GetAttribute(System.String,System.Boolean)">
  202. <summary>
  203. Look for the value of an attribute (specified as parameter) in the
  204. root node. It returns the first attribute which matches with the
  205. given parameters. If desired we can do an depth search in the child
  206. nodes. It is optional due to performance costs (it has to be carefully
  207. used). By default the search is NOT done recursively.
  208. </summary>
  209. <param name="name">Attribute name to search</param>
  210. <param name="searchRecursively">
  211. Allow search recursively in the child nodes (defaults to false).
  212. </param>
  213. <returns>
  214. If found the attribute value, otherwise an empty string.
  215. </returns>
  216. </member>
  217. <member name="M:Delta.Utilities.Xml.XmlNode.GetAllAttributes">
  218. <summary>
  219. Get all attributes, use this method if you want better performance
  220. than calling GetAttribute or GetAttributeAs, which both do a lot of
  221. checking, support recursion (which is slow) and will do all the
  222. conversion for you (again slow). This is the fastest way to get to
  223. attribute values, but you will have to convert types yourself.
  224. </summary>
  225. <returns>
  226. Dictionary with all attributes and values as strings.
  227. </returns>
  228. </member>
  229. <member name="M:Delta.Utilities.Xml.XmlNode.GetAttributeAs``1(System.String,``0,System.String)">
  230. <summary>
  231. Get attribute as any supported datatype that is passed to this generic
  232. method. Note: This currently throws warnings if an attribute is missing
  233. or has no value (empty string), use GetAttribute instead of you don't
  234. want all this extra checking and warnings (this method is slow).
  235. Uses StringHelper.FromInvariantString to convert.
  236. </summary>
  237. <param name="name">Attribute name to search for</param>
  238. <param name="defaultValue">
  239. Default value if the attribute was not found.
  240. </param>
  241. <param name="extraWarningTextIfAnythingGoesWrong">
  242. Extra warning in case anything goes wrong to really help the user to
  243. identify the problem with a related message (e.g. font content name)
  244. </param>
  245. <returns>
  246. Filled T value or defaultValue if attribute was not found or type
  247. conversion is not supported (a log warning will also be outputted).
  248. </returns>
  249. </member>
  250. <member name="M:Delta.Utilities.Xml.XmlNode.GetChild(System.String)">
  251. <summary>
  252. Look for a node with the name specified as parameter. It returns the
  253. first node which matchs with the given parameter.
  254. Note: The search is recursively.
  255. </summary>
  256. <param name="childName">Node name to search</param>
  257. <returns>Node</returns>
  258. </member>
  259. <member name="M:Delta.Utilities.Xml.XmlNode.GetChild(System.String,System.Boolean)">
  260. <summary>
  261. Look for a node with the name specified as parameter. It returns the
  262. first node which matchs with the given parameter.
  263. </summary>
  264. <param name="childName">Node name to search</param>
  265. <param name="searchRecursively">
  266. Allow search recursively in the child nodes?
  267. </param>
  268. </member>
  269. <member name="M:Delta.Utilities.Xml.XmlNode.GetChild(System.String,System.String)">
  270. <summary>
  271. Look for a node with the name specified as parameter and which
  272. contains a particular attribute. This function is thought for when
  273. we have several nodes with the same name to allow the user to
  274. get one with a concrete attribute. It returns the first node which
  275. matchs with the attribute name and value.
  276. Note: The search is recursively.
  277. </summary>
  278. <param name="attributeName">Attribute to search</param>
  279. <param name="attributeValue">Attribute value to search</param>
  280. <returns>Found child node or null if nothing was found</returns>
  281. </member>
  282. <member name="M:Delta.Utilities.Xml.XmlNode.GetChild(System.String,System.String,System.String)">
  283. <summary>
  284. Look for a node with the name specified as parameter and which
  285. contains a particular attribute. This function is thought for when
  286. we have several nodes with the same name to allow the user to
  287. get one with a concrete attribute. It returns the first node which
  288. matchs with the attribute name and value.
  289. Note: The search is recursively.
  290. </summary>
  291. <param name="childName">
  292. Node name to search, can be null for all kind of Xml child nodes.
  293. </param>
  294. <param name="attributeName">Attribute to search</param>
  295. <param name="attributeValue">Attribute value to search</param>
  296. <returns>Found child node or null if nothing was found</returns>
  297. </member>
  298. <member name="M:Delta.Utilities.Xml.XmlNode.GetChild(System.String,System.String,System.String,System.String,System.String)">
  299. <summary>
  300. Look for a node with the name specified as parameter and which
  301. contains two particular attributes. This function is thought for when
  302. we have several nodes with the same name to allow the user to
  303. get one with a concrete attribute. It returns the first node which
  304. matches the attribute names and values.
  305. Note: The search is recursively.
  306. </summary>
  307. <param name="childName">
  308. Node name to search, can be null for all kind of Xml child nodes.
  309. </param>
  310. <param name="attribute1Name">First attribute to search</param>
  311. <param name="attribute1Value">First attribute value to search</param>
  312. <param name="attribute2Name">Second attribute to search</param>
  313. <param name="attribute2Value">Second attribute value to search</param>
  314. <returns>Found child node or null if nothing was found</returns>
  315. </member>
  316. <member name="M:Delta.Utilities.Xml.XmlNode.GetChildCount(System.String)">
  317. <summary>
  318. Gets the number of child that match with the given name.
  319. </summary>
  320. <param name="childName">Child name</param>
  321. <returns>number</returns>
  322. </member>
  323. <member name="M:Delta.Utilities.Xml.XmlNode.GetLastChild(System.String)">
  324. <summary>
  325. Gets last child that matches with the given name.
  326. Note: The search is recursively.
  327. </summary>
  328. <param name="childName">Child name</param>
  329. </member>
  330. <member name="M:Delta.Utilities.Xml.XmlNode.GetLastChild(System.String,System.String)">
  331. <summary>
  332. Gets last child that matches with the given attribute name and value.
  333. Note: The search is recursively.
  334. </summary>
  335. <param name="attributeName">Attribute name</param>
  336. <param name="attributeValue">Attribute value</param>
  337. <returns>XmlNode of the last child or null if not found.</returns>
  338. </member>
  339. <member name="M:Delta.Utilities.Xml.XmlNode.GetLastChild(System.String,System.String,System.String)">
  340. <summary>
  341. Gets last child that matches with the given name.
  342. Note: The search is recursively.
  343. </summary>
  344. <param name="childName">Node name to search</param>
  345. <param name="attributeName">Attribute to search</param>
  346. <param name="attributeValue">Attribute value to search</param>
  347. <returns>XmlNode of the last child or null if not found.</returns>
  348. </member>
  349. <member name="M:Delta.Utilities.Xml.XmlNode.GetAllChildren(System.String)">
  350. <summary>
  351. Look for all nodes with the name specified as parameter and returns
  352. them in an array (non recursive implementation yet).
  353. <para />
  354. <b>Note:</b> Will always return a valid array, in worst case just an
  355. empty one.
  356. </summary>
  357. <param name="childName"></param>
  358. <returns>
  359. Array of XmlNodes from all the children of this node.
  360. </returns>
  361. </member>
  362. <member name="M:Delta.Utilities.Xml.XmlNode.RemoveChild(Delta.Utilities.Xml.XmlNode)">
  363. <summary>
  364. Remove child node from this xml node. Basically just does a Children
  365. remove, but since Children is an array it is not that easy. Note:
  366. This will not check recursively, only a direct children is removed.
  367. </summary>
  368. <param name="childNode">Child XmlNode we want to remove</param>
  369. <returns>True if a child node was removed, false otherwise</returns>
  370. </member>
  371. <member name="M:Delta.Utilities.Xml.XmlNode.RemoveChildRecursively(Delta.Utilities.Xml.XmlNode)">
  372. <summary>
  373. Remove xml child node recursively and return if we found and removed
  374. the given child node.
  375. </summary>
  376. <param name="childNodeToRemove">Child XmlNode we want to remove</param>
  377. <returns>True if a child node was removed, false otherwise</returns>
  378. </member>
  379. <member name="M:Delta.Utilities.Xml.XmlNode.RemoveAllChildren(System.String)">
  380. <summary>
  381. Removes all children with given childName. (Not recursively)
  382. </summary>
  383. <param name="childName">child name</param>
  384. <returns>Number of removed children</returns>
  385. </member>
  386. <member name="M:Delta.Utilities.Xml.XmlNode.Remove">
  387. <summary>
  388. Remove this child node from its parent. Useful to unlink stuff.
  389. </summary>
  390. </member>
  391. <member name="M:Delta.Utilities.Xml.XmlNode.GetWholeDocumentXmlText">
  392. <summary>
  393. Get the whole xml document as formatted xml text.
  394. </summary>
  395. </member>
  396. <member name="M:Delta.Utilities.Xml.XmlNode.GetThisNodeXmlText">
  397. <summary>
  398. Returns the xml text from this node and its children. Use
  399. GetWholeDocumentXmlText to get the xml of the whole file or use
  400. the Name property and GetAttributes for just this node without the
  401. children (this will still return all the children and if we are at
  402. the document level, this returns the same as GetWholeDocumentXmlText.
  403. </summary>
  404. </member>
  405. <member name="M:Delta.Utilities.Xml.XmlNode.Save(System.String)">
  406. <summary>
  407. Save whole xml file (does not matter from which xml node we call this).
  408. In case saving is not possible this method will output a warning in
  409. the log and return false, but does not throw an exception.
  410. </summary>
  411. <param name="filePath">Where to save the ContentMetaData.xml</param>
  412. <returns>
  413. True if saving the file was successful, false (and a log warning)
  414. otherwise.
  415. </returns>
  416. </member>
  417. <member name="M:Delta.Utilities.Xml.XmlNode.Save">
  418. <summary>
  419. Save whole xml file (does not matter from which xml node we call this)
  420. into a memory stream, which contains the same data as if we would have
  421. saved this to a file with the other Save overload. Can be loaded again
  422. with FromMemoryStream.
  423. </summary>
  424. <returns>
  425. The newly created memory stream containing the saved xml file.
  426. </returns>
  427. </member>
  428. <member name="M:Delta.Utilities.Xml.XmlNode.ToString">
  429. <summary>
  430. To string, will return a limited string with max. 200 characters to
  431. get an overview what this XmlNode is about. Use GetXmlText to grab
  432. the full xml text.
  433. </summary>
  434. </member>
  435. <member name="M:Delta.Utilities.Xml.XmlNode.ConstructName(System.String)">
  436. <summary>
  437. if WillChildInheritNamespace is true, it applies the parent
  438. namespace to given name, ignoring any given namespace.
  439. </summary>
  440. <param name="name">name</param>
  441. <returns>Namespace name if this child inherits it, otherwise name
  442. </returns>
  443. </member>
  444. <member name="M:Delta.Utilities.Xml.XmlNode.FindFirstDescendantAttribute(System.Collections.Generic.IEnumerable{System.Xml.Linq.XElement},System.String)">
  445. <summary>
  446. Find the first descendant attribute in a list of Elements. It
  447. searchs in depth through the descendant nodes, searching for a
  448. coincidence with the name. The first match stops inmediatly the
  449. depth-search and returns the attribute.
  450. </summary>
  451. <param name="Elements">Elements to proceed with the search</param>
  452. <param name="name">Name of the searched attribute</param>
  453. <returns>null</returns>
  454. </member>
  455. <member name="P:Delta.Utilities.Xml.XmlNode.Name">
  456. <summary>
  457. Name of the xml root node.
  458. </summary>
  459. </member>
  460. <member name="P:Delta.Utilities.Xml.XmlNode.Value">
  461. <summary>
  462. Value of the xml root node
  463. </summary>
  464. </member>
  465. <member name="P:Delta.Utilities.Xml.XmlNode.Parent">
  466. <summary>
  467. Returns the parent node of this node or 'null' if there is no parent
  468. (anymore).
  469. </summary>
  470. </member>
  471. <member name="P:Delta.Utilities.Xml.XmlNode.Children">
  472. <summary>
  473. Returns children nodes from current parent.
  474. </summary>
  475. </member>
  476. <member name="P:Delta.Utilities.Xml.XmlNode.FilePath">
  477. <summary>
  478. The (absolute) file path from where the xml was loaded (is 'None' if
  479. the XML was created dynamically).
  480. </summary>
  481. </member>
  482. <member name="P:Delta.Utilities.Xml.XmlNode.WillChildInheritNamespace">
  483. <summary>
  484. If disabled (by default all XmlNodes have this disabled):
  485. You have to manually set the namespace on every child node you add,
  486. else it will be empty namespace.
  487. If enabled:
  488. Added children will automatically use the same namespace as parent node
  489. You may set the namespace this way:
  490. XmlNode projectNode =
  491. new XmlNode(
  492. XmlNode.GetNamespaceName(
  493. CsprojXml.Namespace + CsprojXml.ProjectKeyword),
  494. true);
  495. or
  496. node.AddChild(XmlNode.GetNamespaceName("some namespace", "Tag Name"))
  497. </summary>
  498. </member>
  499. <member name="T:Delta.Utilities.Xml.XmlNode.XmlNodeTests">
  500. <summary>
  501. Tests
  502. </summary>
  503. </member>
  504. <member name="F:Delta.Utilities.Xml.XmlNode.XmlNodeTests.testRootNode">
  505. <summary>
  506. Test root node
  507. </summary>
  508. </member>
  509. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.CreateXmlNode">
  510. <summary>
  511. Create xml node. Note: Too slow for a dynamic unit test.
  512. </summary>
  513. </member>
  514. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.FromFile">
  515. <summary>
  516. Load file. Note: Too slow for a dynamic unit test.
  517. </summary>
  518. </member>
  519. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.RemoveAllChildren">
  520. <summary>
  521. Remove all children
  522. </summary>
  523. </member>
  524. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.RemoveChild">
  525. <summary>
  526. Test the RemoveChild functionality
  527. </summary>
  528. </member>
  529. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.GetXmlAttribute">
  530. <summary>
  531. Get xml attribute.
  532. </summary>
  533. </member>
  534. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.ReplaceAttribute">
  535. <summary>
  536. Replace attribute.
  537. </summary>
  538. </member>
  539. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.GetChildNode">
  540. <summary>
  541. Get child node. Note: Too slow for a dynamic unit test.
  542. </summary>
  543. </member>
  544. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.Parent">
  545. <summary>
  546. Parent. Note: Too slow for a dynamic unit test.
  547. </summary>
  548. </member>
  549. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.Childs">
  550. <summary>
  551. Get children. Note: Too slow for a dynamic unit test.
  552. </summary>
  553. </member>
  554. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.GetValueAs">
  555. <summary>
  556. Get xml Value. Note: Too slow for a dynamic unit test.
  557. </summary>
  558. </member>
  559. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.GetAttributeAs">
  560. <summary>
  561. Get attribute. Note: Too slow for a dynamic unit test.
  562. </summary>
  563. </member>
  564. <member name="M:Delta.Utilities.Xml.XmlNode.XmlNodeTests.WillChildInheritNamespace">
  565. <summary>
  566. Get namespace name
  567. </summary>
  568. </member>
  569. <member name="P:Delta.Utilities.Xml.XmlNode.XmlNodeTests.TestXml">
  570. <summary>
  571. Test xml
  572. </summary>
  573. </member>
  574. <member name="T:Delta.Utilities.Xml.XmlHelper">
  575. <summary>
  576. Xml helper class to provide some helper functionality for extracting or
  577. generating xml data from XmlNodes.
  578. </summary>
  579. </member>
  580. <member name="M:Delta.Utilities.Xml.XmlHelper.Serialize(System.String,System.Object)">
  581. <summary>
  582. Serializes an object
  583. This saves an object as an xml structure to a file.
  584. Every variable is saved as a node with
  585. </summary>
  586. <param name="filePath">filepath</param>
  587. <param name="obj">obj</param>
  588. </member>
  589. <member name="M:Delta.Utilities.Xml.XmlHelper.Deserialize(System.String,System.Type)">
  590. <summary>
  591. Deserialize a file to an object
  592. This reads an xml structured file if it's of the same type
  593. as we provide in the parameters
  594. It returns an object by the type we declared and we can
  595. simply cast the object after calling this function
  596. </summary>
  597. <param name="fileName">filename</param>
  598. <param name="type">type</param>
  599. <returns>Deserialized object</returns>
  600. </member>
  601. <member name="M:Delta.Utilities.Xml.XmlHelper.AddDeclaration(System.String,System.String)">
  602. <summary>
  603. Add an xml declaration
  604. </summary>
  605. <param name="version">The current version of the xml file.</param>
  606. <param name="encoding">The current encoding of the xml file.</param>
  607. <returns>xml declaration</returns>
  608. </member>
  609. <member name="M:Delta.Utilities.Xml.XmlHelper.AddTag(System.String)">
  610. <summary>
  611. Create a tag item from the specified string.
  612. </summary>
  613. <param name="tagName">The name of the tag to create.</param>
  614. <returns>string</returns>
  615. </member>
  616. <member name="M:Delta.Utilities.Xml.XmlHelper.AddTag(System.String,System.Int32)">
  617. <summary>
  618. Add a tag with a given depth
  619. </summary>
  620. <param name="tagName">Tag name</param>
  621. <param name="depth">Depth of the node</param>
  622. <returns>Tag with given depth</returns>
  623. </member>
  624. <member name="M:Delta.Utilities.Xml.XmlHelper.AddTagEnd(System.String)">
  625. <summary>
  626. Add a tag end
  627. </summary>
  628. <param name="tagName">Tag name</param>
  629. <returns>tag</returns>
  630. </member>
  631. <member name="M:Delta.Utilities.Xml.XmlHelper.AddTagEnd(System.String,System.Int32)">
  632. <summary>
  633. Add a tag end with a given depth
  634. </summary>
  635. <param name="tagName">Tag name</param>
  636. <param name="depth">Depth of the node</param>
  637. <returns>tag</returns>
  638. </member>
  639. <member name="M:Delta.Utilities.Xml.XmlHelper.AddElement(System.String,System.String)">
  640. <summary>
  641. Add an element
  642. </summary>
  643. <param name="tagName">Tag name</param>
  644. <param name="element">Element</param>
  645. <returns>string</returns>
  646. </member>
  647. <member name="M:Delta.Utilities.Xml.XmlHelper.AddElement(System.String,System.String,System.Int32)">
  648. <summary>
  649. Add an element
  650. </summary>
  651. <param name="tagName">Tag name</param>
  652. <param name="element">Element</param>
  653. <param name="depth">Depth of the node</param>
  654. <returns>string</returns>
  655. </member>
  656. <member name="M:Delta.Utilities.Xml.XmlHelper.AddAttribute(System.String,System.String[],System.String[])">
  657. <summary>
  658. Add an attribute. The number of attribute names and values must be
  659. equal. Each value will be assigned to a name with the corresponding
  660. position in the arrays. (1="1" , 2="2", ...)
  661. </summary>
  662. <param name="tagName">Tag name</param>
  663. <param name="attributeNames">Attribute names</param>
  664. <param name="attributeValues">Attribute values</param>
  665. <returns>xmlNode</returns>
  666. </member>
  667. <member name="M:Delta.Utilities.Xml.XmlHelper.AddAttribute(System.String,System.String[],System.String[],System.Int32)">
  668. <summary>
  669. Add an attribute with a given depth. The number of attribute names and
  670. values must be equal.
  671. Each value will be assigned to a name with the corresponding
  672. position in the arrays. (1="1" , 2="2", ...)
  673. </summary>
  674. <param name="tagName">Tag name</param>
  675. <param name="attributeNames">Attribute names</param>
  676. <param name="attributeValues">Attribute values</param>
  677. <param name="depth">Depth of the node</param>
  678. <returns>string</returns>
  679. </member>
  680. <member name="M:Delta.Utilities.Xml.XmlHelper.AddAttributeEnd(System.String,System.String[],System.String[])">
  681. <summary>
  682. Add an attribute with an end. The number of attribute names and values
  683. must be equal.
  684. Each value will be assigned to a name with the corresponding
  685. position in the arrays. (1="1" , 2="2", ...)
  686. </summary>
  687. <param name="tagName">Tag name</param>
  688. <param name="attributeNames">Attribute names</param>
  689. <param name="attributeValues">Attribute values</param>
  690. <returns>String with the new xmlNode data</returns>
  691. </member>
  692. <member name="M:Delta.Utilities.Xml.XmlHelper.AddAttributeEnd(System.String,System.String[],System.String[],System.Int32)">
  693. <summary>
  694. Add an attribute with a given depth and an end. The number of
  695. attribute names and values must be equal.
  696. Each value will be assigned to a name with the corresponding
  697. position in the arrays. (1="1" , 2="2", ...)
  698. </summary>
  699. <param name="tagName">Tag name</param>
  700. <param name="attributeNames">Attribute names</param>
  701. <param name="attributeValues">Attribute values</param>
  702. <param name="depth">Depth of the node</param>
  703. <returns>string</returns>
  704. </member>
  705. <member name="M:Delta.Utilities.Xml.XmlHelper.AddAttributeElement(System.String,System.String[],System.String[],System.String)">
  706. <summary>
  707. Add an attribute with a given element between the start and end tag.
  708. The number of attribute names and values must be equal.
  709. Each value will be assigned to a name with the corresponding
  710. position in the arrays. (1="1" , 2="2", ...)
  711. </summary>
  712. <param name="tagName">Tag name</param>
  713. <param name="attributeNames">Attribute names</param>
  714. <param name="attributeValues">Attribute values</param>
  715. <param name="element">Element</param>
  716. <returns>string</returns>
  717. </member>
  718. <member name="M:Delta.Utilities.Xml.XmlHelper.AddAttributeElement(System.String,System.String[],System.String[],System.String,System.Int32)">
  719. <summary>
  720. Add an attribute with a given element between the start and end tag and
  721. a given depth.
  722. The number of attribute names and values must be equal.
  723. Each value will be assigned to a name with the corresponding
  724. position in the arrays. (1="1" , 2="2", ...)
  725. </summary>
  726. <param name="tagName">Tag name</param>
  727. <param name="attributeNames">Attribute names</param>
  728. <param name="attributeValues">Attribute values</param>
  729. <param name="element">Element</param>
  730. <param name="depth">Depth of the node</param>
  731. <returns>string</returns>
  732. </member>
  733. <member name="M:Delta.Utilities.Xml.XmlHelper.ConvertToXmlSpecialCharacters(System.String)">
  734. <summary>
  735. Convert to xml special characters, will replace all special characters
  736. that need replacement (&lt; becomes &lt;, " becomes &quot;, etc.).
  737. See http://xml.silmaril.ie/authors/specials/ for more information.
  738. Note: The input text should not already contain special xml characters.
  739. </summary>
  740. <param name="inputText">input text</param>
  741. <returns>string</returns>
  742. </member>
  743. <member name="T:Delta.Utilities.Xml.XmlHelper.XmlHelperTests">
  744. <summary>
  745. Tests
  746. </summary>
  747. </member>
  748. <member name="M:Delta.Utilities.Xml.XmlHelper.XmlHelperTests.LoadFile">
  749. <summary>
  750. Load file. Note: Too slow for a dynamic unit test.
  751. </summary>
  752. </member>
  753. <member name="M:Delta.Utilities.Xml.XmlHelper.XmlHelperTests.LoadingMultipleXmlFiles">
  754. <summary>
  755. Loading multiple xml files. Note: Too slow for dynamic unit tests
  756. </summary>
  757. </member>
  758. <member name="M:Delta.Utilities.Xml.XmlHelper.XmlHelperTests.TestSerialization">
  759. <summary>
  760. Test serialization. Note: This test is too slow for a dynamic unit
  761. test. It also is strange that this c:\testfile.xml is created ..
  762. </summary>
  763. </member>
  764. <member name="M:Delta.Utilities.Xml.XmlHelper.XmlHelperTests.XmlGeneration">
  765. <summary>
  766. XmlGeneration
  767. </summary>
  768. </member>
  769. <member name="M:Delta.Utilities.Xml.XmlHelper.XmlHelperTests.ImportFromXml">
  770. <summary>
  771. Import from xml
  772. </summary>
  773. </member>
  774. <member name="M:Delta.Utilities.Xml.XmlHelper.XmlHelperTests.LoadSnippet">
  775. <summary>
  776. Load snippet
  777. </summary>
  778. </member>
  779. <member name="M:Delta.Utilities.Xml.XmlHelper.XmlHelperTests.ConvertToXmlSpecialCharacters">
  780. <summary>
  781. Convert to xml special characters
  782. </summary>
  783. </member>
  784. </members>
  785. </doc>