Option<T> Sınıf

Tanım

Ad Alanı:

System.CommandLine

Bütünleştirilmiş Kod:

System.CommandLine.dll

Paket:

System.CommandLine v3.0.0-preview.7.26381.103

Kaynak:

Option{T}.cs

Adlandırılmış parametreyi tanımlayan bir simge ve bu parametre için bir değer.

generic <typename T>
public ref class Option : System::CommandLine::Option

public class Option<T> : System.CommandLine.Option

type Option<'T> = class
    inherit Option

Public Class Option(Of T)
Inherits Option

Tür Parametreleri

T

Type Seçenek bağımsız değişkenlerinin olarak ayrıştırılması beklenir.

Devralma

Object

Symbol

Option

Option<T>

Oluşturucular

Name	Description
Option<T>(String, String[])	Option sınıfının yeni bir örneğini başlatır.

Özellikler

Name	Description
Action	Option için öğesini CommandLineAction alır veya ayarlar. İşleyici, Option çağrıldığında gerçekleştirilecek eylemi temsil eder. (Devralındığı yer: Option)
Aliases	Seçenek belirtmek için komut satırında kullanılabilecek benzersiz dize kümesini alır. (Devralındığı yer: Option)
AllowMultipleArgumentsPerToken	Her seçenek tanımlayıcı belirteci için birden çok bağımsız değişken belirtecinin izin verilip verilmeyeceğini belirten bir değer alır. (Devralındığı yer: Option)
Arity	Seçeneğin arity'sini alır veya ayarlar. (Devralındığı yer: Option)
CompletionSources	Seçeneğin tamamlanma kaynaklarının listesini alır. (Devralındığı yer: Option)
CustomParser	Özel bir bağımsız değişken ayrıştırıcısı alır veya ayarlar.
DefaultValueFactory	Varsayılan değeri oluşturmak için temsilciyi çağıracak şekilde alır veya ayarlar.
Description	Simgenin açıklamasını alır veya ayarlar. (Devralındığı yer: Symbol)
HasDefaultValue	Seçenek için varsayılan bir değerin tanımlandığını belirtir. (Devralındığı yer: Option)
HelpName	Seçeneğin değeri için kullanım yardımında gösterilen yer tutucu adını alır veya ayarlar. Değer açılı ayraçlar (< ve >) içine sarmalanır. (Devralındığı yer: Option)
Hidden	Sembolün gizlenip gizlenmediğini belirten bir değer alır veya ayarlar. (Devralındığı yer: Symbol)
Name	Simgenin adını alır. (Devralındığı yer: Symbol)
Parents	Üst simgeleri alır. (Devralındığı yer: Symbol)
Recursive	True olarak ayarlandığında, bu seçenek hemen üst komutuna veya komutlarına uygulanır ve alt komutlarına özyinelemeli olarak uygulanır. (Devralındığı yer: Option)
Required	Üst komutu çağrıldığında seçeneğin gerekli olup olmadığını gösterir. (Devralındığı yer: Option)
Validators	Seçenek ayrıştırıcı tarafından eşleştirildiğinde çağrılacak doğrulayıcılar. (Devralındığı yer: Option)
ValueType	Seçeneğin Type ayrıştırılan belirteçlerinin dönüştürüleceği değeri alır.

Yöntemler

Name	Description
AcceptLegalFileNamesOnly()	seçeneğini yalnızca yasal dosya adlarını temsil eden değerleri kabul etmek üzere yapılandırılır.
AcceptLegalFilePathsOnly()	seçeneğini yalnızca yasal dosya yollarını temsil eden değerleri kabul etmek üzere yapılandırılır.
AcceptOnlyFromAmong(String[])	Seçeneğini yalnızca belirtilen değerleri kabul etmek ve bunları komut satırı tamamlamaları olarak önermek üzere yapılandırılır.
AcceptOnlyFromAmong(StringComparer, String[])	Seçeneği, belirtilen karşılaştırıcıyı kullanarak yalnızca belirtilen değerleri kabul etmek ve bunları komut satırı tamamlamaları olarak önermek üzere yapılandırır.
GetCompletions(CompletionContext)	Simgenin tamamlanmalarını alır. (Devralındığı yer: Option)
GetDefaultValue()	seçeneği için varsayılan değeri alır. (Devralındığı yer: Option)
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Symbol)

Uzantı Özellikleri

Name	Description
IsDynamic	Bu seçeneğin tamamlanma zamanındaki tamamlama işlemlerini hesaplamak için uygulamanın kendisine (yerleşik [suggest] yönerge aracılığıyla) dinamik bir çağrı gerekip gerekmediğini gösterir.

Uzantı Metotları

Name	Description
AcceptExistingOnly<T>(Option<T>)	Yalnızca var olan dosyalara veya dizinlere karşılık gelen değerleri kabul etmek için bir seçenek yapılandırılır.
IsFlag(Option)	Adlandırılmış parametreyi tanımlayan bir simge ve bu parametre için bir değer.
Names(Option)	Birincil ad ve tüm diğer adlar dahil olmak üzere bir seçeneğin tüm adlarını alma
PrimaryNameAndAliases(Option)	Adlandırılmış parametreyi tanımlayan bir simge ve bu parametre için bir değer.