UsageFooterAttribute Class

Gets or sets a footer that will be added to the usage help for an arguments class.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 4.2.0+a4d3631e4dcc0970081ed435288efdebc1325f83
C#
public class UsageFooterAttribute : Attribute
Inheritance
Object    Attribute    UsageFooterAttribute

Remarks

The DescriptionAttribute attribute provides text that's written at the top of the usage help. The UsageFooterAttribute attribute does the same thing, but for text that's written at the bottom of the usage help.

The footer will only be used when the full usage help is shown, using UsageHelpRequestFull.

You can derive from this attribute to use an alternative source for the footer, such as a resource table that can be localized.

Constructors

UsageFooterAttribute Initializes a new instance of the UsageFooterAttribute class.

Properties

Footer Gets the footer text.
FooterValue Gets the footer text stored in this attribute.
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)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
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)
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ToStringReturns a string that represents the current object.
(Inherited from Object)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also