File size: 4,146 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Xml;
namespace System.Management.Automation
{
/// <summary>
/// Class MamlClassHelpInfo keeps track of help information to be returned by
/// class help provider.
/// </summary>
internal class MamlClassHelpInfo : HelpInfo
{
/// <summary>
/// Constructor for custom HelpInfo object creation.
/// </summary>
/// <param name="helpObject"></param>
/// <param name="helpCategory"></param>
internal MamlClassHelpInfo(PSObject helpObject, HelpCategory helpCategory)
{
HelpCategory = helpCategory;
_fullHelpObject = helpObject;
}
/// <summary>
/// Convert a XMLNode to HelpInfo object.
/// </summary>
/// <param name="xmlNode"></param>
/// <param name="helpCategory"></param>
private MamlClassHelpInfo(XmlNode xmlNode, HelpCategory helpCategory)
{
HelpCategory = helpCategory;
MamlNode mamlNode = new MamlNode(xmlNode);
_fullHelpObject = mamlNode.PSObject;
this.Errors = mamlNode.Errors;
_fullHelpObject.TypeNames.Clear();
_fullHelpObject.TypeNames.Add("PSClassHelpInfo");
}
/// <summary>
/// PSObject representation on help.
/// </summary>
private readonly PSObject _fullHelpObject;
#region Load
/// <summary>
/// Create a MamlClassHelpInfo object from an XmlNode.
/// </summary>
/// <param name="xmlNode">XmlNode that contains help info.</param>
/// <param name="helpCategory">Help category this maml object fits into.</param>
/// <returns>MamlCommandHelpInfo object created.</returns>
internal static MamlClassHelpInfo Load(XmlNode xmlNode, HelpCategory helpCategory)
{
MamlClassHelpInfo mamlClassHelpInfo = new MamlClassHelpInfo(xmlNode, helpCategory);
if (string.IsNullOrEmpty(mamlClassHelpInfo.Name))
return null;
mamlClassHelpInfo.AddCommonHelpProperties();
return mamlClassHelpInfo;
}
#endregion
#region Helper Methods and Overloads
/// <summary>
/// Clone the help info object.
/// </summary>
/// <returns>MamlClassHelpInfo object.</returns>
internal MamlClassHelpInfo Copy()
{
MamlClassHelpInfo result = new MamlClassHelpInfo(_fullHelpObject.Copy(), this.HelpCategory);
return result;
}
/// <summary>
/// Clone the help object with a new category.
/// </summary>
/// <param name="newCategoryToUse"></param>
/// <returns>MamlClassHelpInfo.</returns>
internal MamlClassHelpInfo Copy(HelpCategory newCategoryToUse)
{
MamlClassHelpInfo result = new MamlClassHelpInfo(_fullHelpObject.Copy(), newCategoryToUse);
result.FullHelp.Properties["Category"].Value = newCategoryToUse.ToString();
return result;
}
internal override string Name
{
get
{
string tempName = string.Empty;
var title = _fullHelpObject.Properties["title"];
if (title != null && title.Value != null)
{
tempName = title.Value.ToString();
}
return tempName;
}
}
internal override string Synopsis
{
get
{
string tempSynopsis = string.Empty;
var intro = _fullHelpObject.Properties["introduction"];
if (intro != null && intro.Value != null)
{
tempSynopsis = intro.Value.ToString();
}
return tempSynopsis;
}
}
internal override HelpCategory HelpCategory { get; }
internal override PSObject FullHelp
{
get { return _fullHelpObject; }
}
#endregion
}
}
|