HelpOption Sınıf

Tanım

Ad Alanı:

System.CommandLine.Help

Bütünleştirilmiş Kod:

System.CommandLine.dll

Paket:

System.CommandLine v3.0.0-preview.7.26381.103

Kaynak:

HelpOption.cs

Komut satırı yardımının görüntülenmesi gerektiğini belirten standart bir seçenek.

public ref class HelpOption sealed : System::CommandLine::Option

public sealed class HelpOption : System.CommandLine.Option

type HelpOption = class
    inherit Option

Public NotInheritable Class HelpOption
Inherits Option

Devralma

Object

Symbol

Option

HelpOption

Oluşturucular

Name	Description
HelpOption()	öğesine Commandeklendiğinde, komut satırında aşağıdaki seçeneklerden biri belirtildiğinde yardım göstermek için uygulamayı yapılandırılır: -h /h --help -? /?
HelpOption(String, String[])	uygulamasına Commandeklendiğinde, komut satırında verilen ad veya diğer adlardan biri belirtildiğinde yardım göstermek için uygulamayı yapılandırıyor.

Ö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.
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)
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	Komut satırı yardımının görüntülenmesi gerektiğini belirten standart bir seçenek.

Yöntemler

Name	Description
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)