ParentCommandAttribute Class

Indicates the parent command for a nested subcommand.

Definition

Namespace: Ookii.CommandLine.Commands
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.0.0+bb7ed9a8fdfd1cb21824750a8cf508863ad15086
C#
public sealed class ParentCommandAttribute : Attribute
Inheritance
Object    Attribute    ParentCommandAttribute

Remarks

If you wish to have a command with nested subcommands, apply this attribute to the children of another command. The CommandManager class will only return commands whose ParentCommandTypeName property value matches the CommandOptionsParentCommand property.

The parent command type should be the type of another command. It may be a command derived from the ParentCommand class, but this is not required. The ParentCommand class makes implementing nested subcommands easy, but you may also use any command with your own nested subcommand logic as a parent command.

To create a hierarchy of subcommands, the command with this attribute may itself also have nested subcommands.

Constructors

ParentCommandAttribute(String) Initializes a new instance of the ParentCommandAttribute class.
ParentCommandAttribute(Type) Initializes a new instance of the ParentCommandAttribute class.

Properties

ParentCommandTypeName Gets or sets the name of the parent command type.
TypeIdWhen implemented in a derived class, gets a unique identifier for this Attribute.
(Inherited from Attribute)

Methods

EqualsReturns a value that indicates whether this instance is equal to a specified object.
(Inherited from Attribute)
GetHashCodeReturns the hash code for this instance.
(Inherited from Attribute)
GetTypeGets the Type of the current instance.
(Inherited from Object)
IsDefaultAttributeWhen overridden in a derived class, indicates whether the value of this instance is the default value for the derived class.
(Inherited from Attribute)
MatchWhen overridden in a derived class, returns a value that indicates whether this instance equals a specified object.
(Inherited from Attribute)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Thread Safety

Static members of this type are safe for multi-threaded operations. Instance members of this type are safe for multi-threaded operations.

See Also