is (C#-Referenz)is (C# Reference)

Überprüft, ob ein Objekt mit einem angegebenen Typ kompatibel ist; gleicht ab C# 7 einen Ausdruck mit einem Muster ab.Checks if an object is compatible with a given type, or (starting with C# 7) tests an expression against a pattern.

Prüfen auf TypkompatibilitätTesting for type compatibility

Das is-Schlüsselwort wertet die Typkompatibilität zur Laufzeit aus.The is keyword evaluates type compatibility at runtime. Es bestimmt, ob eine Instanz eines Objekts oder das Ergebnis eines Ausdrucks in einen angegebenen Typen konvertiert werden kann.It determines whether an object instance or the result of an expression can be converted to a specified type. Es besitzt die SyntaxIt has the syntax

   expr is type

in der expr ein Ausdruck ist, der die Instanz eines Typs auswertet und type der Name des Typs, in den das Ergebnis von expr konvertiert werden soll.where expr is an expression that evaluates to an instance of some type, and type is the name of the type to which the result of expr is to be converted. Die Anweisung is ist true, wenn expr nicht NULL ist, und das Objekt, das beim Auswerten des Ausdrucks entsteht, kann in Typ konvertiert werden; andernfalls gibt es false zurück.The is statement is true if expr is non-null and the object that results from evaluating the expression can be converted to type; otherwise, it returns false.

Der folgende Code bestimmt beispielsweise, ob obj in eine Instanz des Typs Person umgewandelt werden kann:For example, the following code determines if obj can be cast to an instance of the Person type:

if (obj is Person) {
   // Do something if obj is a Person.
}

Die Anweisung is ist TRUE, wenn:The is statement is true if:

  • expr eine Instanz des gleichen Typs wie Typ ist.expr is an instance of the same type as type.

  • expr ist eine Instanz eines Typs, der von Typ abgeleitet wird.expr is an instance of a type that derives from type. Das Ergebnis von expr kann, in anderen Worten, in eine Instanz von Typ umgewandelt werden.In other words, the result of expr can be upcast to an instance of type.

  • expr hat einen Kompilierzeittyp, der eine Basisklasse von Typ ist, und expr hat einen Runtime-Typ,der Typ ist oder von Typ abgeleitet wird.expr has a compile-time type that is a base class of type, and expr has a runtime type that is type or is derived from type. Der Kompilierzeittyp einer Variablen ist der Typ der Variablen, wie in der Deklaration des Typs definiert.The compile-time type of a variable is the variable's type as defined in its declaration. Der Laufzeittyp einer Variablen ist der Typ der Instanz, die dieser Variablen zugewiesen wird.The runtime type of a variable is the type of the instance that is assigned to that variable.

  • expr ist eine Instanz eines Typs, der die Schnittstelle Typ implementiert.expr is an instance of a type that implements the type interface.

Im folgenden Beispiel wird veranschaulicht, wie der Ausdruck is für jede dieser Konvertierungen true ergibt.The following example shows that the is expression evaluates to true for each of these conversions.

using System;

public class Class1 : IFormatProvider
{
   public object GetFormat(Type t)
   {
      if (t.Equals(this.GetType()))      
         return this;
      return null;
   }
}

public class Class2 : Class1
{
   public int Value { get; set; }
}

public class Example
{
   public static void Main()
   {
      var cl1 = new Class1();
      Console.WriteLine(cl1 is IFormatProvider);
      Console.WriteLine(cl1 is Object);
      Console.WriteLine(cl1 is Class1);
      Console.WriteLine(cl1 is Class2); 
      Console.WriteLine();
 
      var cl2 = new Class2();
      Console.WriteLine(cl2 is IFormatProvider);
      Console.WriteLine(cl2 is Class2);
      Console.WriteLine(cl2 is Class1);
      Console.WriteLine();
      
      Class1 cl = cl2;
      Console.WriteLine(cl is Class1);
      Console.WriteLine(cl is Class2);
   }
}
// The example displays the following output:
//     True
//     True
//     True
//     False
//     
//     True
//     True
//     True
//     
//     True
//     True

Das Schlüsselwort is generiert eine Kompilierzeitwarnung, wenn der Ausdruck immer entweder true oder false ist.The is keyword generates a compile-time warning if the expression is known to always be either true or false. Es berücksichtigt nur Verweis-, Boxing- und Unboxing-Konvertierungen; es berücksichtigt keine benutzerdefinierten Konvertierungen oder Konvertierungen, die von den impliziten und expliziten Operatoren eines Typs definiert wurden.It only considers reference conversions, boxing conversions, and unboxing conversions; it does not consider user-defined conversions or conversions defined by a type's implicit and explicit operators. Das folgende Beispiel generiert Warnungen, weil das Ergebnis der Konvertierung zur Kompilierzeit bekannt ist.The following example generates warnings because the result of the conversion is known at compile-time. Bitte beachten Sie, dass der Ausdruck is für Konvertierungen von int in long und double FALSE zurückgibt, da diese Konvertierungen vom impliziten Operator verarbeitet werden.Note that the is expression for conversions from int to long and double return false, since these conversions are handled by the implicit operator.

Console.WriteLine(3 is int);
Console.WriteLine();

int value = 6;
Console.WriteLine(value is long);
Console.WriteLine(value is double);
Console.WriteLine(value is object);
Console.WriteLine(value is ValueType);
Console.WriteLine(value is int);
// Compilation generates the following compiler warnings:
//   is2.cs(8,25): warning CS0183: The given expression is always of the provided ('int') type
//   is2.cs(12,25): warning CS0184: The given expression is never of the provided ('long') type
//   is2.cs(13,25): warning CS0184: The given expression is never of the provided ('double') type
//   is2.cs(14,25): warning CS0183: The given expression is always of the provided ('object') type
//   is2.cs(15,25): warning CS0183: The given expression is always of the provided ('ValueType') type
//   is2.cs(16,25): warning CS0183: The given expression is always of the provided ('int') type

expr kann jeder beliebige Ausdruck sein, der einen Wert zurückgibt – davon ausgenommen sind anonyme Methoden und Lambdaausdrücke.expr can be any expression that returns a value, with the exception of anonymous methods and lambda expressions. Im folgenden Beispiel wird is verwendet, um den Rückgabewert eines Methodenaufrufs auszuwerten.The following example uses is to evaluate the return value of a method call.

using System;

public class Example
{
   public static void Main()
   {
      double number1 = 12.63; 
      if (Math.Ceiling(number1) is double)
         Console.WriteLine("The expression returns a double.");
      else if (Math.Ceiling(number1) is decimal)    
         Console.WriteLine("The expression returns a decimal.");

      decimal number2 = 12.63m; 
      if (Math.Ceiling(number2) is double)
         Console.WriteLine("The expression returns a double.");
      else if (Math.Ceiling(number2) is decimal)    
         Console.WriteLine("The expression returns a decimal.");

   }
}
// The example displays the following output:
//     The expression returns a double.
//     The expression returns a decimal.

Ab C# 7 können Sie den Musterabgleich mit dem Typmuster verwenden, um präziseren Code zu schreiben, der die Anweisung is verwendet.Starting with C# 7, you can use pattern matching with the type pattern to write more concise code that uses the is statement.

Musterabgleich mit isPattern matching with is

Ab C# 7 unterstützen die Auszüge is und switch den Musterabgleich.Starting with C# 7, the is and switch statements support pattern matching. Das Schlüsselwort is unterstützt folgende Muster:The is keyword supports the following patterns:

  • Das Typmuster, das prüft, ob ein Ausdruck in einen bestimmten Typ konvertiert werden kann; sofern dies möglich ist, wandelt es diesen in eine Variable dieses Typs um.Type pattern, which tests whether an expression can be converted to a specified type and, if it can be, casts it to a variable of that type.

  • Das Konstantenmuster, das prüft, ob ein Ausdruck einen angegebenen konstanten Wert ergibt.Constant pattern, which tests whether an expression evaluates to a specified constant value.

  • Das Variablenmuster, eine Übereinstimmung, die immer erfolgreich ausführt wird und den Wert eines Ausdrucks an eine neue lokale Variable bindet.var pattern, a match that always succeeds and binds the value of an expression to a new local variable.

Typmuster Type pattern

Wenn Sie das Typmuster verwenden, um einen Musterabgleich durchzuführen, prüft is, ob ein Ausdruck in einen angegebenen Typen konvertiert werden kann; sofern dies möglich ist, wandelt es diesen in eine Variable dieses Typ um.When using the type pattern to perform pattern matching, is tests whether an expression can be converted to a specified type and, if it can be, casts it to a variable of that type. Dies ist eine einfach Erweiterung der is-Anweisung, der eine präzise Auswertung und Konvertierung der Typs ermöglicht.It is a straightforward extension of the is statement that enables concise type evaluation and conversion. Die allgemeine Form des Typmusters is ist:The general form of the is type pattern is:

   expr is type varname 

Hier ist expr ein Ausdruck, der eine Instanz eines beliebigen Typen ergibt, Typ ist der Name des Typen, in den das Ergebnis von expr konvertiert werden soll, und varname ist das Objekt, in das das Ergebnis von expr konvertiert wird, wenn der is-Test true ist.where expr is an expression that evaluates to an instance of some type, type is the name of the type to which the result of expr is to be converted, and varname is the object to which the result of expr is converted if the is test is true.

Der Ausdruck is ist true, wenn eine der folgenden Aussagen zutrifft:The is expression is true if any of the following is true:

  • expr ist eine Instanz des gleichen Typs wie Typ.expr is an instance of the same type as type.

  • expr ist eine Instanz eines Typs, der von Typ abgeleitet wird.expr is an instance of a type that derives from type. Das Ergebnis von expr kann, in anderen Worten, in eine Instanz von Typ umgewandelt werden.In other words, the result of expr can be upcast to an instance of type.

  • expr hat einen Kompilierzeittyp, der eine Basisklasse von Typ ist, und expr hat einen Runtime-Typ,der Typ ist oder von Typ abgeleitet wird.expr has a compile-time type that is a base class of type, and expr has a runtime type that is type or is derived from type. Der Kompilierzeittyp einer Variablen ist der Typ der Variablen, wie in der Deklaration des Typs definiert.The compile-time type of a variable is the variable's type as defined in its declaration. Der Laufzeittyp einer Variablen ist der Typ der Instanz, die dieser Variablen zugewiesen wird.The runtime type of a variable is the type of the instance that is assigned to that variable.

  • expr ist eine Instanz eines Typs, der die Schnittstelle Typ implementiert.expr is an instance of a type that implements the type interface.

Wenn expr true ist, und is mit der if-Anweisung verwendet wird, wird varname zugewiesen und ist nur lokal innerhalb der Anweisung if gültig.If exp is true and is is used with an if statement, varname is assigned and has local scope within the if statement only.

Im folgenden Beispiel wird das is-Typmuster verwendet, um die Implementierung der Methode IComparable.CompareTo(Object) des Typs bereitzustellen.The following example uses the is type pattern to provide the implementation of a type's IComparable.CompareTo(Object) method.

using System;

public class Employee : IComparable
{
    public String Name { get; set; }
    public int Id { get; set; }

    public int CompareTo(Object o)
    {
        if (o is Employee e)
        {
            return Name.CompareTo(e.Name);
        }
        throw new ArgumentException("o is not an Employee object.");
    }
}

Ohne Musterabgleich könnte dieser Code wie folgt geschrieben werden.Without pattern matching, this code might be written as follows. Die Verwendung des Typenmusterabgleichs erzeugt einen kompakteren, lesbaren Code, da nicht mehr geprüft werden muss, ob das Ergebnis einer Umwandlung null ist.The use of type pattern matching produces more compact, readable code by eliminating the need to test whether the result of a conversion is a null.

using System;

public class Employee : IComparable
{
    public String Name { get; set; }
    public int Id { get; set; }

    public int CompareTo(Object o)
    {
        var e = o as Employee;
        if (e == null)
        {
           throw new ArgumentException("o is not an Employee object.");
        }
        return Name.CompareTo(e.Name);
    }
}

Das Typmuster is erstellt zusätzlich kompakteren Code, wenn der Typ eines Werttyps bestimmt wird.The is type pattern also produces more compact code when determining the type of a value type. Im folgenden Beispiel wird das Typmuster is verwendet, um zu bestimmen, ob ein Objekt eine Instanz von Person oder Dog ist, bevor der Wert einer passenden Eigenschaft angezeigt wird.The following example uses the is type pattern to determine whether an object is a Person or a Dog instance before displaying the value of an appropriate property.

using System;

public class Example
{
   public static void Main()
   {
      Object o = new Person("Jane");
      ShowValue(o);
      
      o = new Dog("Alaskan Malamute");
      ShowValue(o);
   }

   public static void ShowValue(object o)
   {
      if (o is Person p) {
         Console.WriteLine(p.Name);
      }   
      else if (o is Dog d) {
         Console.WriteLine(d.Breed);
      }             
   }
}

public struct Person
{  
   public string Name { get; set; }
   
   public Person(string name) : this()
   {
      Name = name;
   }
}

public struct Dog
{
   public string Breed { get; set; }

   public Dog(string breedName) : this()
   {
      Breed = breedName;
   }
}
// The example displays the following output:
//	Jane
//	Alaskan Malamute

Der gleichwertige Code erfordert ohne einen Musterabgleich eine gesonderte Zuweisung, die eine explizite Umwandlung beinhaltet.The equivalent code without pattern matching requires a separate assignment that includes an explicit cast.

using System;

public class Example
{
   public static void Main()
   {
      Object o = new Person("Jane");
      ShowValue(o);
      
      o = new Dog("Alaskan Malamute");
      ShowValue(o);
   }

   public static void ShowValue(object o)
   {
      if (o is Person) {
         Person p = (Person) o;
         Console.WriteLine(p.Name);
      }   
      else if (o is Dog) {
         Dog d = (Dog) o;
         Console.WriteLine(d.Breed);
      }             
   }
}

public struct Person
{  
   public string Name { get; set; }
   
   public Person(string name) : this()
   {
      Name = name;
   }
}

public struct Dog
{
   public string Breed { get; set; }

   public Dog(string breedName) : this()
   {
      Breed = breedName;
   }
}
// The example displays the following output:
//       Jane
//       Alaskan Malamute

Konstantenmuster Constant pattern

Beim Durchführen eines Musterabgleichs mit einem Konstantenmuster prüft is, ob ein Ausdruck einer angegebenen Konstanten entspricht.When performing pattern matching with the constant pattern, is tests whether an expression equals a specified constant. In C# 6 und früheren Versionen wird das Konstantenmuster von der Anweisung switch unterstützt.In C# 6 and earlier versions, the constant pattern is supported by the switch statement. Ab C# 7 wird es ebenfalls von der Anweisung is unterstützt.Starting with C# 7, it is supported by the is statement as well. Die Syntax lautet:Its syntax is:

   expr is constant

Hier ist expr der auszuwertende Ausdruck, und constant ist der Wert, auf den geprüft werden soll.where expr is the expression to evaluate, and constant is the value to test for. constant kann einer der folgenden konstanten Ausdrücke sein:constant can be any of the following constant expressions:

  • Ein Literalwert.A literal value.

  • Der Name einer deklarierten const-Variable.The name of a declared const variable.

  • Eine Enumerationskonstante.An enumeration constant.

Der konstante Ausdruck wird wie folgt ausgewertet:The constant expression is evaluated as follows:

  • Wenn expr und constant integrale Typen sind, bestimmt der C#-Gleichheitsoperator, ob der Ausdruck true (d.h., ob expr == constant) zurückgibt.If expr and constant are integral types, the C# equality operator determines whether the expression returns true (that is, whether expr == constant).

  • Andernfalls wird der Wert des Ausdrucks durch einen Aufruf der statischen Methode Object.Equals (expr, constant) bestimmt.Otherwise, the value of the expression is determined by a call to the static Object.Equals(expr, constant) method.

Im folgenden Beispiel werden Typ- und Konstantenmuster miteinander vereint, um zu prüfen, ob ein Objekt eine Dice-Instanz ist; ist dem so, wird geprüft, ob der Wert eines Würfelvorgangs 6 ist.The following example combines the type and constant patterns to test whether an object is a Dice instance and, if it is, to determine whether the value of a dice roll is 6.

using System;

public class Dice
{
    Random rnd = new Random();
    public Dice()
    {

    }
    public int Roll()
    {
        return rnd.Next(1, 7); 
    }
}

class Program
{
    static void Main(string[] args)
    {
        var d1 = new Dice();
        ShowValue(d1);
    }

    private static void ShowValue(object o)
    {
        const int HIGH_ROLL = 6;

        if (o is Dice d && d.Roll() is HIGH_ROLL)
            Console.WriteLine($"The value is {HIGH_ROLL}!");
        else
            Console.WriteLine($"The dice roll is not a {HIGH_ROLL}!");
     }
}
// The example displays output like the following:
//      The value is 6!

Variablenmuster var pattern

Eine Musterübereinstimmung mit einem Variablenmuster wird immer erfolgreich ausgeführt.A pattern match with the var pattern always succeeds. Deren Syntax lautetIts syntax is

   expr is var varname

Hier wird der Wert von expr immer einer lokalen Variablen mit dem Namen varname zugewiesen.where the value of expr is always assigned to a local variable named varname. varname ist eine statische Variable des gleichen Typs wie expr.varname is a static variable of the same type as expr. In folgendem Beispiel wird das Variablenmuster verwendet, um einen Ausdruck einer Variablen mit dem Namen obj zuzuweisen.The following example uses the var pattern to assign an expression to a variable named obj. Dann zeigt es den Wert und den Typ von obj an.It then displays the value and the type of obj.

using System;

class Program
{
    static void Main()
   {
      object[] items = { new Book("The Tempest"), new Person("John") };
      foreach (var item in items) {
        if (item is var obj)
          Console.WriteLine($"Type: {obj.GetType().Name}, Value: {obj}"); 
      }
   }
}

class Book
{
    public Book(string title) 
    {
       Title = title;    
    }

    public string Title { get; set; }

    public override string ToString()
    {
       return Title;
    }
}

class Person
{
   public Person(string name)
   {
      Name = name;
   }

   public string Name 
   { get; set; }

   public override string ToString()
   {
      return Name;
   }
}
// The example displays the following output:
//       Type: Book, Value: The Tempest
//       Type: Person, Value: John

Bitte beachten Sie, dass der Ausdruck is immer noch TRUE ist und null varname zuweist, wenn expr null ist.Note that if expr is null, the is expression still is true and assigns null to varname.

C#-ProgrammiersprachenspezifikationC# Language Specification

Weitere Informationen erhalten Sie unter C#-Sprachspezifikation. Die Sprachspezifikation ist die verbindliche Quelle für die Syntax und Verwendung von C#.

Siehe auchSee also

C#-ReferenzC# Reference
C#-SchlüsselwörterC# Keywords
typeoftypeof
asas
OperatorschlüsselwörterOperator Keywords