ParamArrayAttribute Klas

Definitie

Naamruimte:

System

Assembly's:

netstandard.dll, System.Runtime.dll

Bron:

ParamArrayAttribute.cs

Geeft aan dat een methode een variabel aantal argumenten in de aanroep toestaat. Deze klasse kan niet worden overgenomen.

public ref class ParamArrayAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=true)]
public sealed class ParamArrayAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Parameter, AllowMultiple=false, Inherited=true)>]
type ParamArrayAttribute = class
    inherit Attribute

Public NotInheritable Class ParamArrayAttribute
Inherits Attribute

Overname

Object

Attribute

ParamArrayAttribute

Kenmerken

AttributeUsageAttribute

Voorbeelden

In het volgende voorbeeld wordt een Temperature klasse gedefinieerd die een Display methode bevat, die is bedoeld om een of meer opgemaakte temperatuurwaarden weer te geven. De methode heeft één parameter, formatsdie wordt gedefinieerd als een parametermatrix.

using System;

public class Temperature
{
   private decimal temp;

   public Temperature(decimal temperature)
   {
      this.temp = temperature;
   }

   public override string ToString()
   {
      return ToString("C");
   }

   public string ToString(string format)
   {
      if (String.IsNullOrEmpty(format))
         format = "G";

      switch (format.ToUpper())
      {
         case "G":
         case "C":
            return temp.ToString("N") + "  °C";
         case "F":
            return (9 * temp / 5 + 32).ToString("N") + "  °F";
         case "K":
            return (temp + 273.15m).ToString("N") + "  °K";
         default:
            throw new FormatException(String.Format("The '{0}' format specifier is not supported",
                                                    format));
      }
   }

   public void Display(params string []formats)
   {
      if (formats.Length == 0)
      {
         Console.WriteLine(this.ToString("G"));
      }
      else
      {
         foreach (string format in formats)
         {
            try {
               Console.WriteLine(this.ToString(format));
            }
            // If there is an exception, do nothing.
            catch { }
         }
      }
   }
}

open System

type Temperature(temperature) =
    override this.ToString() =
        this.ToString "C"

    member _.ToString(format) =
        let format = 
            if String.IsNullOrEmpty format then "G"
            else format

        match format.ToUpper() with
        | "G" | "C" ->
            $"{temperature:N}  °C"
        | "F" ->
            $"{9. * temperature / 5. + 32.:N}  °F"
        | "K" ->
            $"{temperature + 273.15:N}  °K"
        | _ ->
            raise (FormatException $"The '{format}' format specifier is not supported")

    member this.Display([<ParamArray>]formats: string[]) =
        if formats.Length = 0 then
            printfn $"""{this.ToString "G"}"""
        else
            for format in formats do
                try
                    printfn $"{this.ToString format}"
                // If there is an exception, do nothing.
                with _ -> ()

Public Class Temperature 
   Private temp As Decimal
   
   Public Sub New(temperature As Decimal)
      Me.temp = temperature
   End Sub
   
   Public Overrides Function ToString() As String
      Return ToString("C")
   End Function
   
   Public Overloads Function ToString(format As String) As String
      If String.IsNullOrEmpty(format) Then format = "G"
      
      Select Case format
         Case "G", "C"
            Return temp.ToString("N") + "  °C"
         Case "F"
            Return (9 * temp / 5 + 32).ToString("N") + "  °F"
         Case "K" 
            Return (temp + 273.15d).ToString("N") + "  °K" 
         Case Else
            Throw New FormatException(String.Format("The '{0}' format specifier is not supported", _
                                                    format))
      End Select                                                         
   End Function         
   
   Public Sub Display(<[ParamArray]()> formats() As String)
      If formats.Length = 0 Then
         Console.WriteLine(Me.ToString("G"))
      Else   
         For Each format As String In formats
            Try
               Console.WriteLine(Me.ToString(format))
            ' If there is an exception, do nothing.
            Catch
            End Try   
         Next
      End If
   End Sub
End Class

In het volgende voorbeeld ziet u drie verschillende aanroepen naar de Temperature.Display methode. In de eerste wordt de methode doorgegeven aan een matrix met notatietekenreeksen. In de tweede wordt de methode als argumenten doorgegeven aan vier afzonderlijke notatietekenreeksen. In de derde wordt de methode zonder argumenten aangeroepen. Zoals de uitvoer uit het voorbeeld laat zien, vertalen de Visual Basic- en C#-compilers dit in een aanroep naar de methode Display met een lege tekenreeksmatrix.

public class Class1
{
   public static void Main()
   {
      Temperature temp1 = new Temperature(100);
      string[] formats = { "C", "G", "F", "K" };

      // Call Display method with a string array.
      Console.WriteLine("Calling Display with a string array:");
      temp1.Display(formats);
      Console.WriteLine();

      // Call Display method with individual string arguments.
      Console.WriteLine("Calling Display with individual arguments:");
      temp1.Display("C", "F", "K", "G");
      Console.WriteLine();

      // Call parameterless Display method.
      Console.WriteLine("Calling Display with an implicit parameter array:");
      temp1.Display();
   }
}
// The example displays the following output:
//       Calling Display with a string array:
//       100.00  °C
//       100.00  °C
//       212.00  °F
//       373.15  °K
//
//       Calling Display with individual arguments:
//       100.00  °C
//       212.00  °F
//       373.15  °K
//       100.00  °C
//
//       Calling Display with an implicit parameter array:
//       100.00  °C

let temp1 = Temperature 100.
let formats = [| "C"; "G"; "F"; "K" |]

// Call Display method with a string array.
printfn "Calling Display with a string array:"
temp1.Display formats

// Call Display method with individual string arguments.
printfn "\nCalling Display with individual arguments:"
temp1.Display("C", "F", "K", "G")

// Call parameterless Display method.
printfn "\nCalling Display with an implicit parameter array:"
temp1.Display()
// The example displays the following output:
//       Calling Display with a string array:
//       100.00  °C
//       100.00  °C
//       212.00  °F
//       373.15  °K
//
//       Calling Display with individual arguments:
//       100.00  °C
//       212.00  °F
//       373.15  °K
//       100.00  °C
//
//       Calling Display with an implicit parameter array:
//       100.00  °C

Public Module Example
   Public Sub Main()
      Dim temp1 As New Temperature(100)
      Dim formats() As String = { "C", "G", "F", "K" } 

      ' Call Display method with a string array.
      Console.WriteLine("Calling Display with a string array:")
      temp1.Display(formats)
      Console.WriteLine()
      
      ' Call Display method with individual string arguments.
      Console.WriteLine("Calling Display with individual arguments:")
      temp1.Display("C", "F", "K", "G")
      Console.WriteLine()
      
      ' Call parameterless Display method.
      Console.WriteLine("Calling Display with an implicit parameter array:")
      temp1.Display()
   End Sub
End Module
' The example displays the following output:
'       Calling Display with a string array:
'       100.00  °C
'       100.00  °C
'       212.00  °F
'       373.15  °K
'       
'       Calling Display with individual arguments:
'       100.00  °C
'       212.00  °F
'       373.15  °K
'       100.00  °C
'       
'       Calling Display with an implicit parameter array:
'       100.00  °C

Opmerkingen

Hiermee ParamArrayAttribute wordt aangegeven dat een methodeparameter een parametermatrix is. Een parametermatrix staat de specificatie van een onbekend aantal argumenten toe. Een parametermatrix moet de laatste parameter in een formele parameterlijst zijn en moet een matrix met één dimensie zijn. Wanneer de methode wordt aangeroepen, staat een parametermatrix argumenten toe aan een methode die op twee manieren kan worden opgegeven:

• Als één expressie van een type dat impliciet wordt geconverteerd naar het parametermatrixtype. De parametermatrix fungeert als een waardeparameter.

• Als nul of meer argumenten, waarbij elk argument een expressie is van een type dat impliciet kan worden omgezet in het type parametermatrixelement.

In het voorbeeld in de volgende sectie ziet u beide aanroepende conventies.

Note

Normaal gesproken wordt deze ParamArrayAttribute niet rechtstreeks in code gebruikt. In plaats daarvan worden afzonderlijke taaltrefwoorden, zoals ParamArray in Visual Basic en params in C#, gebruikt als wrappers voor de klasse ParamArrayAttribute. Sommige talen, zoals C#, kunnen zelfs het gebruik van het trefwoord taal vereisen en het gebruik van ParamArrayAttribute.

Wanneer compilers die parametermatrices ondersteunen tijdens overbelastingsresolutie te maken krijgen met een methodeoverbelasting die niet bestaat, maar één minder parameter heeft dan een overbelasting die een parametermatrix bevat, vervangen ze de methode door de overbelasting die de parametermatrix bevat. Een aanroep naar de String.Split() instantiemethode (die niet in de String klasse bestaat) wordt bijvoorbeeld omgezet als een aanroep naar de String.Split(Char[]) methode. De compiler geeft ook een lege matrix van het vereiste type door aan de methode. Dit betekent dat de methode altijd moet worden voorbereid om een matrix te verwerken waarvan de lengte nul is wanneer de elementen in de parametermatrix worden verwerkt. In het voorbeeld ziet u een afbeelding.

Zie Kenmerken voor meer informatie over het gebruik van kenmerken.

Constructors

Name	Description
ParamArrayAttribute()	Initialiseert een nieuw exemplaar van de ParamArrayAttribute klasse met standaardeigenschappen.

Eigenschappen

Name	Description
TypeId	Wanneer deze wordt geïmplementeerd in een afgeleide klasse, krijgt u Attributehiervoor een unieke id. (Overgenomen van Attribute)

Methoden

Name	Description
Equals(Object)	Retourneert een waarde die aangeeft of dit exemplaar gelijk is aan een opgegeven object. (Overgenomen van Attribute)
GetHashCode()	Retourneert de hash-code voor dit exemplaar. (Overgenomen van Attribute)
GetType()	Hiermee haalt u de Type huidige instantie op. (Overgenomen van Object)
IsDefaultAttribute()	Wanneer deze wordt overschreven in een afgeleide klasse, geeft u aan of de waarde van dit exemplaar de standaardwaarde is voor de afgeleide klasse. (Overgenomen van Attribute)
Match(Object)	Wanneer deze wordt overschreven in een afgeleide klasse, wordt een waarde geretourneerd die aangeeft of dit exemplaar gelijk is aan een opgegeven object. (Overgenomen van Attribute)
MemberwiseClone()	Hiermee maakt u een ondiepe kopie van de huidige Object. (Overgenomen van Object)
ToString()	Retourneert een tekenreeks die het huidige object vertegenwoordigt. (Overgenomen van Object)

Zie ook

• Attribute
• Metagegevens uitbreiden met behulp van kenmerken