UsageWriter.GetArgumentsInDescriptionOrder Method

Gets the parser's arguments filtered according to the ArgumentDescriptionListFilter property and sorted by category and according to the ArgumentDescriptionListOrder property.

Definition

Namespace: Ookii.CommandLine
Assembly: Ookii.CommandLine (in Ookii.CommandLine.dll) Version: 5.0.0+724ca9b7fa5edc075ec2ae65044e61b0d494fd1c
C#
protected virtual IEnumerable<CommandLineArgument> GetArgumentsInDescriptionOrder()

Return Value

IEnumerable<CommandLineArgument>
A list of filtered and sorted arguments.

Remarks

If any of the arguments use the CommandLineArgumentAttribute.Category property, the arguments are sorted by category based on the category's enumeration values, and sorted according to the ArgumentDescriptionListOrder property within each category. Arguments that have no category set are returned before any arguments that do have a category.

Arguments that are hidden are excluded from the list, even if DescriptionListFilterMode.All is used.

See Also