Option Klass

Definition

Namnområde:: System.CommandLine

Sammansättning:: System.CommandLine.dll

Paket:: System.CommandLine v3.0.0-rc.1.26425.128

Paket:: System.CommandLine.Experimental v0.3.0-alpha.19577.1

Källa:: Option.cs

Källa:: Option.cs

Källa:: Option.cs

Viktigt

En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.

En symbol som definierar en namngiven parameter och ett värde för den parametern.

public ref class Option abstract : System::CommandLine::Symbol

public ref class Option : System::CommandLine::Symbol, System::CommandLine::IOption

public abstract class Option : System.CommandLine.Symbol

public class Option : System.CommandLine.Symbol, System.CommandLine.IOption

type Option = class
    inherit Symbol

type Option = class
    inherit Symbol
    interface IOption
    interface ISymbol
    interface ISuggestionSource
    interface IValueDescriptor

Public MustInherit Class Option
Inherits Symbol

Public Class Option
Inherits Symbol
Implements IOption

Arv: Object

Symbol
Option

Härledda: System.CommandLine.Help.HelpOption

System.CommandLine.Option<T>

System.CommandLine.VersionOption

Implementeringar: IValueDescriptor IOption ISuggestionSource ISymbol

Konstruktorer

Name	Description
Option(String, String)	En symbol som definierar en namngiven parameter och ett värde för den parametern.
Option(String, String[])	Initierar en ny instans av Option klassen.
Option(String[], String)	En symbol som definierar en namngiven parameter och ett värde för den parametern.

Egenskaper

Name	Description
Action	Hämtar eller anger CommandLineAction för alternativet. Hanteraren representerar den åtgärd som ska utföras när alternativet anropas.
Aliases	Hämtar den unika uppsättning strängar som kan användas på kommandoraden för att ange alternativet.
Aliases	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
AllowMultipleArgumentsPerToken	Hämtar ett värde som anger om flera argumenttoken tillåts för varje alternatividentifierartoken.
Argument	En symbol som definierar en namngiven parameter och ett värde för den parametern.
Arity	Hämtar eller anger alternativets aritet.
Children	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
CompletionSources	Hämtar listan över slutförandekällor för alternativet.
Description	Hämtar eller anger beskrivningen av symbolen. (Ärvd från Symbol)
HasDefaultValue	Anger om ett standardvärde har definierats för alternativet.
HelpName	Hämtar eller anger platshållarnamnet som visas i användningshjälpen för alternativets värde. Värdet kommer att omslutas i vinkelparenteser (`<` och `>`).
Hidden	Hämtar eller anger ett värde som anger om symbolen är dold. (Ärvd från Symbol)
IsHidden	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
Name	Hämtar namnet på symbolen. (Ärvd från Symbol)
Parents	Hämtar de överordnade symbolerna. (Ärvd från Symbol)
RawAliases	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
Recursive	När värdet är true tillämpas det här alternativet på dess omedelbara överordnade kommando eller kommandon och rekursivt på deras underkommandon.
Required	Anger om alternativet krävs när dess överordnade kommando anropas.
Validators	Validatorer som anropas när alternativet matchas av parsern.
ValueType	Hämtar det Type som alternativets parsade token konverteras till.

Metoder

Name	Description
AddAlias(String)	En symbol som definierar en namngiven parameter och ett värde för den parametern.
AddAliasInner(String)	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
AddValidator(ValidateSymbol<OptionResult>)	En symbol som definierar en namngiven parameter och ett värde för den parametern.
ClearAliases()	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
GetCompletions(CompletionContext)	Hämtar slutföranden för symbolen.
GetDefaultValue()	Hämtar standardvärdet för alternativet.
HasAlias(String)	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
HasRawAlias(String)	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
Suggest(String)	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
ToString()	Returnerar en sträng som representerar det aktuella objektet. (Ärvd från Symbol)

Explicita gränssnittsimplementeringar

Name	Description
IOption.Argument	En symbol som definierar en namngiven parameter och ett värde för den parametern.
ISymbol.Children	En symbol som definierar en namngiven parameter och ett värde för den parametern. (Ärvd från Symbol)
IValueDescriptor.GetDefaultValue()	En symbol som definierar en namngiven parameter och ett värde för den parametern.
IValueDescriptor.HasDefaultValue	En symbol som definierar en namngiven parameter och ett värde för den parametern.
IValueDescriptor.Type	En symbol som definierar en namngiven parameter och ett värde för den parametern.
IValueDescriptor.ValueName	En symbol som definierar en namngiven parameter och ett värde för den parametern.

Tilläggsmetoder

Name	Description
BuildAlias(IValueDescriptor)	En symbol som definierar en namngiven parameter och ett värde för den parametern.
Parse(Option, String)	En symbol som definierar en namngiven parameter och ett värde för den parametern.

Gäller för

Feedback

Var den här sidan till hjälp?