//http://validationframework.codeplex.com/ //License: Microsoft Permissive License (Ms-PL) v1.1 using System; using System.Xml; namespace ValidationFramework.Extensions { public static class XmlElementExtensions { /// <summary> /// Attempts to get and convert an attribute from a <see cref="XmlElement"/>. If the item does not exist or can't be converted a <paramref name="defaultValue"/> is returned. /// </summary> /// <typeparam name="T">The <see cref="Type"/> to try to convert to.</typeparam> /// <param name="element">The <see cref="XmlElement"/> to extract the attribute value from.</param> /// <param name="key">The key to use or the extraction</param> /// <param name="defaultValue">The default value if <paramref name="key"/> is not found.</param> /// <returns>The value from <paramref name="attributes"/> if <paramref name="key"/> exists; otherwise <paramref name="defaultValue"/>.</returns> internal static T GetAttribute<T>(this XmlElement element, string key, T defaultValue) { if (!element.HasAttribute(key)) return defaultValue; var stringValue = element.GetAttribute(key); var converter = System.ComponentModel.TypeDescriptor.GetConverter(typeof(T)); if (!converter.CanConvertFrom(typeof(string))) return defaultValue; return (T)converter.ConvertFromString(stringValue); } } }
XML-RPC
Attempts to get and cast attribute from an XmlElement
//http://validationframework.codeplex.com/ //License: Microsoft Permissive License (Ms-PL) v1.1 using System; using System.Xml; namespace ValidationFramework.Extensions { public static class XmlElementExtensions { /// <summary> /// Attempts to get and cast attribute from a <see cref="XmlElement"/>. If the item does not exist or can't be casted exceptions are thrown. /// </summary> /// <typeparam name="T">The <see cref="Type"/> to try to convert to.</typeparam> /// <param name="element">The <see cref="XmlElement"/> to extract the attribute value from.</param> /// <param name="key">The key to use or the extraction</param> /// <param name="defaultValue">The default value if <paramref name="key"/> is not found.</param> /// <returns>The value from <paramref name="attributes"/> if <paramref name="key"/> exists; otherwise <paramref name="defaultValue"/>.</returns> /// <exception cref="ArgumentOutOfRangeException"></exception> internal static T GetAttribute<T>(this XmlElement element, string key) { if (!element.HasAttribute(key)) throw new ArgumentOutOfRangeException(string.Format("The key '{0}' cannot be found in xml element.", key)); var stringValue = element.GetAttribute(key); var converter = System.ComponentModel.TypeDescriptor.GetConverter(typeof(T)); return (T)converter.ConvertFromString(stringValue); } } }
Get boolean value if an attribute is 1 or true
//Microsoft Public License (Ms-PL) //http://dbmlmanager.codeplex.com/license #region using using System; using System.Xml; #endregion namespace DbmlManager.Lib.Utility { #region Class Docs /// <summary> /// Summary description for XmlUtil. /// </summary> #endregion public class XmlUtil { #region GetBoolAttrib(XmlNode node, string attrib, bool defVal) public static bool GetBoolAttrib(XmlNode node, string attrib, bool defVal) { XmlAttribute xmlAttrib = node.Attributes[attrib]; if (xmlAttrib == null) return defVal; string val = xmlAttrib.Value; if (val == null || val == string.Empty) return defVal; bool returnVal = (val == "1" || val.ToLower() == "true"); return returnVal; } #endregion } }
Adds an XmlAttribute to a XmlNode
#region License and Copyright /* * Dotnet Commons Xml * * * This library is free software; you can redistribute it and/or modify it * under the terms of the GNU Lesser General Public License as published by * the Free Software Foundation; either version 2.1 of the License, or * (at your option) any later version. * * This library is distributed in the hope that it will be useful, but * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License * for more details. * * You should have received a copy of the GNU Lesser General Public License * along with this library; if not, write to the * Free Software Foundation, Inc., * 59 Temple Place, * Suite 330, * Boston, * MA 02111-1307 * USA * */ #endregion using System; using System.Collections; using System.Collections.Specialized; using System.Diagnostics; using System.IO; using System.Reflection; using System.Text; using System.Text.RegularExpressions; using System.Xml; using System.Xml.Xsl; using System.Xml.Serialization; //using Dotnet.Commons.Reflection; namespace Dotnet.Commons.Xml { /// /// <summary> /// This utility class contains wrapper functions that help to ease the handling and /// manipulation of Xml documents, such as adding an element, adding an attribute /// to an element, copying and cloning of nodes, etc. /// /// </summary> /// public abstract class XmlUtils { /// ------------------------------------------------------------------- /// <summary> /// Adds an <see cref="XmlAttribute"/> to a <see cref="XmlNode"/>. /// </summary> /// <param name="node">Node in which an attribute is to be added</param> /// <param name="attributeName">attribute name</param> /// <param name="attributeValue">value of the attribute</param> /// <returns>true if successful, false otherwise</returns> /// ------------------------------------------------------------------- public static void AddAttribute(XmlNode node, string attributeName, string attributeValue) { node.Attributes.Append(CreateAttribute(node, attributeName, attributeValue)); } /// ----------------------------------------------------------- /// <summary> /// Create an <see cref="XmlAttribute"/>. /// </summary> /// <param name="xmlDocument">XmlDocument object</param> /// <param name="attrName">name of the attribute</param> /// <param name="attrValue">value of the attribute</param> /// <returns>an instance of an XmlAttribute object</returns> /// ----------------------------------------------------------- public static XmlAttribute CreateAttribute(XmlDocument xmlDocument, string attrName, string attrValue) { XmlAttribute oAtt = xmlDocument.CreateAttribute(attrName); oAtt.Value = attrValue; return oAtt; } /// ----------------------------------------------------------- /// <summary> /// Create an <see cref="XmlAttribute"/> /// </summary> /// <param name="node">Node to use for creating an attribute</param> /// <param name="attrName">name of the attribute</param> /// <param name="attrValue">value of the attribute</param> /// <returns>an instance of an XmlAttribute object</returns> /// ----------------------------------------------------------- public static XmlAttribute CreateAttribute(XmlNode node, string attrName, string attrValue) { return (CreateAttribute(node.OwnerDocument, attrName, attrValue)); } /// ----------------------------------------------------------- /// <summary> /// Adds an <see cref="XmlAttribute"/> to a <see cref="XmlNode"/>. /// </summary> /// <param name="node">Node in which an attribute is to be added</param> /// <param name="namespaceUri"></param> /// <param name="attributeName">attribute name</param> /// <param name="attributeValue">value of the attribute</param> /// <returns>true if successful, false otherwise</returns> /// ----------------------------------------------------------- public static void AddAttribute(XmlNode node, string namespaceUri, string attributeName, string attributeValue) { XmlAttribute attribute = node.OwnerDocument.CreateAttribute(attributeName, namespaceUri); attribute.Value = attributeValue; node.Attributes.Append(attribute); } } }
Get Attribute and return Int64 or throw exception
//Microsoft Public License (Ms-PL) //http://dbmlmanager.codeplex.com/license #region using using System; using System.Xml; #endregion namespace DbmlManager.Lib.Utility { #region Class Docs /// <summary> /// Summary description for XmlUtil. /// </summary> #endregion public class XmlUtil { #region GetAttrib(XmlNode node, string attrib, string defVal) public static string GetAttrib(XmlNode node, string attrib, string defVal) { XmlAttribute xmlAttrib = node.Attributes[attrib]; if (xmlAttrib == null) return defVal; string val = xmlAttrib.Value; return (val == null) ? defVal : val; } #endregion #region GetInt64AttribOrThrow(XmlNode node, string attrib) public static Int64 GetInt64AttribOrThrow(XmlNode node, string attrib) { string val = GetAttrib(node, attrib, null); if (val == null) throw new Exception(String.Format("Attribute '{0}' not specified in node '{1}'", attrib, node.Name)); if (val == null || val == string.Empty) return 0; Int64 returnVal = 0; Int64.TryParse(val, out returnVal); return returnVal; } #endregion } }
Get Attribute and return Int64
//Microsoft Public License (Ms-PL) //http://dbmlmanager.codeplex.com/license #region using using System; using System.Xml; #endregion namespace DbmlManager.Lib.Utility { #region Class Docs /// <summary> /// Summary description for XmlUtil. /// </summary> #endregion public class XmlUtil { #region GetAttrib(XmlNode node, string attrib, string defVal) public static string GetAttrib(XmlNode node, string attrib, string defVal) { XmlAttribute xmlAttrib = node.Attributes[attrib]; if (xmlAttrib == null) return defVal; string val = xmlAttrib.Value; return (val == null) ? defVal : val; } #endregion #region GetInt64Attrib(XmlNode node, string attrib, Int64 defVal) public static Int64 GetInt64Attrib(XmlNode node, string attrib, Int64 defVal) { XmlAttribute xmlAttrib = node.Attributes[attrib]; if (xmlAttrib == null) return defVal; string val = xmlAttrib.Value; if (val == null || val == string.Empty) return defVal; Int64 returnVal = defVal; Int64.TryParse(val, out returnVal); return returnVal; } #endregion } }
Get attribute value and convert to integer type or throw exception
//Microsoft Public License (Ms-PL) //http://dbmlmanager.codeplex.com/license #region using using System; using System.Xml; #endregion namespace DbmlManager.Lib.Utility { #region Class Docs /// <summary> /// Summary description for XmlUtil. /// </summary> #endregion public class XmlUtil { public static string GetAttrib(XmlNode node, string attrib, string defVal) { XmlAttribute xmlAttrib = node.Attributes[attrib]; if (xmlAttrib == null) return defVal; string val = xmlAttrib.Value; return (val == null) ? defVal : val; } #region GetIntAttribOrThrow(XmlNode node, string attrib) public static int GetIntAttribOrThrow(XmlNode node, string attrib) { string val = GetAttrib(node, attrib, null); if (val == null) throw new Exception(String.Format("Attribute '{0}' not specified in node '{1}'", attrib, node.Name)); if (val == null || val == string.Empty) return 0; int returnVal = 0; int.TryParse(val, out returnVal); return returnVal; } #endregion } }