Exemple #1
0
        /// <summary>
        /// If the schema annotated item is deprecated, get its deprecation description.
        /// </summary>
        /// <param name="annotated">The annotated item.</param>
        /// <returns>The deprecation description if the item is deprecated; null otherwise.</returns>
        private string GetDeprecatedDescription(XmlSchemaAnnotated annotated)
        {
            if (annotated.Annotation == null)
            {
                return null;
            }

            foreach (XmlSchemaObject obj in annotated.Annotation.Items)
            {
                if (obj is XmlSchemaAppInfo)
                {
                    XmlSchemaAppInfo appInfo = (XmlSchemaAppInfo)obj;

                    foreach (XmlNode node in appInfo.Markup)
                    {
                        XmlElement element = node as XmlElement;

                        if (element != null && element.LocalName == "deprecated" && element.NamespaceURI == XmlSchemaExtensionNamespace)
                        {
                            string newNamespace = element.GetAttribute("namespace");
                            string newReference = element.GetAttribute("ref");

                            if (newReference != null && 0 < newReference.Length)
                            {
                                if (annotated is XmlSchemaAttribute)
                                {
                                    return String.Format("This attribute has been deprecated; please use the {0} attribute instead.", newReference);
                                }
                                else if (annotated is XmlSchemaElement)
                                {
                                    XmlSchemaElement schemaElement = (XmlSchemaElement)annotated;

                                    if (newNamespace.Length == 0)
                                    {
                                        newNamespace = schemaElement.QualifiedName.Namespace;
                                    }

                                    return String.Format("This element has been deprecated; please use the {0} element instead.", this.GetElementLink(new XmlQualifiedName(newReference, newNamespace)));
                                }
                                else
                                {
                                    throw new InvalidOperationException(String.Format("Unsupported deprecated element found inside '{0}'.", annotated.GetType().ToString()));
                                }
                            }
                            else
                            {
                                if (annotated is XmlSchemaAttribute)
                                {
                                    return "This attribute has been deprecated.";
                                }
                                else if (annotated is XmlSchemaElement)
                                {
                                    return "This element has been deprecated.";
                                }
                                else
                                {
                                    throw new InvalidOperationException(String.Format("Unsupported deprecated element found inside '{0}'.", annotated.GetType().ToString()));
                                }
                            }
                        }
                    }
                }
            }

            return null;
        }