Class HelpCategoryAttribute

Assigns command or all commands in the handler to a specific category in help list.

Inheritance
System.Object
System.Attribute
HelpCategoryAttribute
Implements
System.IEquatable<HelpCategoryAttribute>
Namespace: TehGM.Wolfringo.Commands
Assembly: Wolfringo.Commands.dll
Syntax
[AttributeUsage(AttributeTargets.Class | AttributeTargets.Method, AllowMultiple = false, Inherited = false)]
public class HelpCategoryAttribute : Attribute, IEquatable<HelpCategoryAttribute>

Constructors

| Improve this Doc View Source

HelpCategoryAttribute(String)

Assigns command or all commands in the handler to a specific category in help list, with priority of 0.

Declaration
public HelpCategoryAttribute(string name)
Parameters
Type Name Description
System.String name

Name of the category.
| Improve this Doc View Source

HelpCategoryAttribute(String, Int32)

Assigns command or all commands in the handler to a specific category in help list.

Declaration
public HelpCategoryAttribute(string name, int priority)
Parameters
Type Name Description
System.String name

Name of the category.
System.Int32 priority

Priority of the category.

Properties

| Improve this Doc View Source

Name

Name of the category.

Declaration
public string Name { get; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Priority

Priority of the category.

Declaration
public int Priority { get; set; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

Equals(Object)

Check if the categories should be treated as the same.

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
System.Object obj

The category attribute to compare with.
Returns
Type Description
System.Boolean

True if obj is HelpCategoryAttribute and the categories are considered to be the same; otherwise false.
Overrides
System.Attribute.Equals(System.Object)
Remarks

Categories are treated the same if the name matches, case insensitively.

| Improve this Doc View Source

Equals(HelpCategoryAttribute)

Check if the categories should be treated as the same.

Declaration
public bool Equals(HelpCategoryAttribute other)
Parameters
Type Name Description
HelpCategoryAttribute other

The category attribute to compare with.
Returns
Type Description
System.Boolean

True if the categories are considered to be the same; otherwise false.
Remarks

Categories are treated the same if the name matches, case insensitively.

| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32
Overrides
System.Attribute.GetHashCode()

Implements

System.IEquatable<T>