.NET Framework Class Library
EnumerableMaxTSource Method (IEnumerableTSource)

Returns the maximum value in a generic sequence.

Namespace:   System.Linq
Assemblies:   System.Linq (in System.Linq.dll)
  System.Core (in System.Core.dll)
Syntax
<[%$TOPIC/bb347632_en-us_VS_110_1_0_0_0_0%]> _
Public Shared Function Max(Of TSource) ( _
	source As [%$TOPIC/bb347632_en-us_VS_110_1_0_0_0_1%](Of TSource) _
) As TSource
public static TSource Max<TSource>(
	this [%$TOPIC/bb347632_en-us_VS_110_1_0_1_0_0%]<TSource> source
)
[[%$TOPIC/bb347632_en-us_VS_110_1_0_2_0_0%]]
public:
generic<typename TSource>
static TSource Max(
	[%$TOPIC/bb347632_en-us_VS_110_1_0_2_0_1%]<TSource>^ source
)
static member Max : 
        source:[%$TOPIC/bb347632_en-us_VS_110_1_0_3_0_0%]<'TSource> -> 'TSource 

Type Parameters

TSource

The type of the elements of source.

Parameters

source
Type: System.Collections.GenericIEnumerableTSource

A sequence of values to determine the maximum value of.

Return Value

Type: TSource
The maximum value in the sequence.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IEnumerableTSource. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).
Exceptions
ExceptionCondition
ArgumentNullException

source is .

Remarks

If type TSource implements IComparableT, the MaxTSource(IEnumerableTSource) method uses that implementation to compare values. Otherwise, if type TSource implements IComparable, that implementation is used to compare values.

If TSource is a reference type and the source sequence is empty or contains only values that are , this method returns .

In Visual Basic query expression syntax, an Aggregate Into Max() clause translates to an invocation of Max.

Examples

The following code example demonstrates how to use MaxTSource(IEnumerableTSource) to determine the maximum value in a sequence of IComparableT objects.

    ' This class implements IComparable  
    ' and has a custom 'CompareTo' implementation. 
    Class Pet
        Implements IComparable(Of Pet)

        Public Name As String 
        Public Age As Integer 

        ''' <summary> 
        ''' Compares Pet objects by the sum of their age and name length. 
        ''' </summary> 
        ''' <param name="other">The Pet to compare this Pet to.</param> 
        ''' <returns>-1 if this Pet's sum is 'less' than the other Pet, 
        ''' 0 if they are equal, 
        ''' or 1 if this Pet's sum is 'greater' than the other Pet.</returns> 
        Function CompareTo(ByVal other As Pet) As Integer _
            Implements IComparable(Of Pet).CompareTo

            If (other.Age + other.Name.Length > Me.Age + Me.Name.Length) Then 
                Return -1
            ElseIf (other.Age + other.Name.Length = Me.Age + Me.Name.Length) Then 
                Return 0
            Else 
                Return 1
            End If 
        End Function 
    End Class 

    Sub MaxEx3()
        ' Create an array of Pet objects. 
        Dim pets() As Pet = {New Pet With {.Name = "Barley", .Age = 8}, _
                             New Pet With {.Name = "Boots", .Age = 4}, _
                             New Pet With {.Name = "Whiskers", .Age = 1}}

        ' Find the "maximum" pet according to the  
        ' custom CompareTo() implementation. 
        Dim max As Pet = pets.Max()

        ' Display the result.
        MsgBox("The 'maximum' animal is " & max.Name)
    End Sub 

    ' This code produces the following output: 
    ' 
    ' The 'maximum' animal is Barley
/// <summary> 
            /// This class implements IComparable to be able to  
            /// compare one Pet to another Pet. 
            /// </summary> 
            class Pet : IComparable<Pet>
            {
                public string Name { get; set; }
                public int Age { get; set; }

                /// <summary> 
                /// Compares this Pet to another Pet by  
                /// summing each Pet's age and name length. 
                /// </summary> 
                /// <param name="other">The Pet to compare this Pet to.</param>
                /// <returns>-1 if this Pet is 'less' than the other Pet,  
                /// 0 if they are equal, 
                /// or 1 if this Pet is 'greater' than the other Pet.</returns> 
                int IComparable<Pet>.CompareTo(Pet other)
                {
                    int sumOther = other.Age + other.Name.Length;
                    int sumThis = this.Age + this.Name.Length;

                    if (sumOther > sumThis)
                        return -1;
                    else if (sumOther == sumThis)
                        return 0;
                    else 
                        return 1;
                }
            }

            public static void MaxEx3()
            {
                Pet[] pets = { new Pet { Name="Barley", Age=8 },
                               new Pet { Name="Boots", Age=4 },
                               new Pet { Name="Whiskers", Age=1 } };

                Pet max = pets.Max();

                Console.WriteLine(
                    "The 'maximum' animal is {0}.",
                    max.Name);
            }

            /*
             This code produces the following output:

             The 'maximum' animal is Barley.
            */
Version Information

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Store apps

Supported in: Windows 8

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8
Platforms

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.