Dil

Command Sınıf

Tanım

Uygulamanın gerçekleştirdiği belirli bir eylemi temsil eder.

public ref class Command : System::CommandLine::Symbol, System::Collections::IEnumerable
public class Command : System.CommandLine.Symbol, System.Collections.IEnumerable
type Command = class
    inherit Symbol
    interface IEnumerable
Public Class Command
Inherits Symbol
Implements IEnumerable
Devralma
Command
Türetilmiş
Uygulamalar

Açıklamalar

Belirli bir dizeye (komut adı) karşılık gelen eylemler için Command nesnesini kullanın. Yalnızca bir eylemi olan basit uygulamalar için bkz RootCommand. . Örneğin, dotnet run komutu olarak kullanır run .

Oluşturucular

Veri Akışı Adı Description
Command(String, String)

Command sınıfının yeni bir örneğini başlatır.

Özellikler

Veri Akışı Adı Description
Action

Komutu için öğesini CommandLineAction alır veya ayarlar. İşleyici, Komut çağrıldığında gerçekleştirilecek eylemi temsil eder.

Aliases

Komutu belirtmek için komut satırında kullanılabilecek benzersiz dize kümesini alır.

Arguments

Komutun tüm bağımsız değişkenlerini alır.

Children

Alt simgelerini alır.

Description

Simgenin açıklamasını alır veya ayarlar.

(Devralındığı yer: Symbol)
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)
Options

Komutun tüm seçeneklerini alır.

Parents

Üst simgeleri alır.

(Devralındığı yer: Symbol)
Subcommands

Komutun tüm alt komutlarını alır.

TreatUnmatchedTokensAsErrors

Eşleşmeyen belirteçlerin hata olarak kabul edilip edilmeyeceğini belirten bir değer alır veya ayarlar.

Validators

komutuna doğrulayıcıları alır. Doğrulayıcılar özel doğrulama mantığı oluşturmak için kullanılabilir.

Yöntemler

Veri Akışı Adı Description
Add(Argument)

komutuna bir Argument ekler.

Add(Command)

komutuna bir Command ekler.

Add(Option)

komutuna bir Option ekler.

GetCompletions(CompletionContext)

Simgenin tamamlanmalarını alır.

Parse(IReadOnlyList<String>, ParserConfiguration)

komutunu kullanarak dizi dizelerini ayrıştırıyor.

Parse(String, ParserConfiguration)

komutunu kullanarak bir komut satırı dize değeri ayrıştırıyor.

SetAction(Action<ParseResult>)

Komut çağrıldığında çalıştırılacak zaman uyumlu eylemi ayarlar.

SetAction(Func<ParseResult,CancellationToken,Task<Int32>>)

Komut çağrıldığında zaman uyumsuz bir eylem ayarlar.

SetAction(Func<ParseResult,CancellationToken,Task>)

Komut çağrıldığında çalıştırılacak zaman uyumsuz eylemi ayarlar.

SetAction(Func<ParseResult,Int32>)

Komut çağrıldığında çalıştırılacak zaman uyumlu eylemi ayarlar.

SetAction(Func<ParseResult,Task<Int32>>)

Komut çağrıldığında çalıştırılacak zaman uyumsuz eylemi ayarlar.

SetAction(Func<ParseResult,Task>)

Komut çağrıldığında çalıştırılacak zaman uyumsuz eylemi ayarlar.

ToString()

Geçerli nesneyi temsil eden bir dize döndürür.

(Devralındığı yer: Symbol)

Belirtik Arabirim Kullanımları

Veri Akışı Adı Description
IEnumerable.GetEnumerator()

Bir koleksiyonda yineleyen bir numaralandırıcı döndürür.

Uzantı Metotları

Veri Akışı Adı Description
ConfigureFromMethod(Command, MethodInfo, Object)

Uygulamanın gerçekleştirdiği belirli bir eylemi temsil eder.

FunctionName(Command, String[])

Bir komut için benzersiz bir kabuk işlevi adı oluşturun. Bu adlar

  • 'root' komutunun adından farklı (örneğin, ikili 'dotnet' için 'dotnet' işlev adını oluşturmamalıyız)
  • bu işleve ulaşmak için 'path' temelinde distinct (bu nedenle parentCommandNames)
HierarchicalOptions(Command)

Uygulamanın gerçekleştirdiği belirli bir eylemi temsil eder.

Names(Command)

Birincil ad ve tüm diğer adlar dahil olmak üzere bir komutun tüm adlarını alma

UseCommandHandler<THandler>(Command)

Uygulamanın gerçekleştirdiği belirli bir eylemi temsil eder.

Şunlara uygulanır