WorksheetFunction.Aggregate Method

  • Article

Returns an aggregate in a list or database.

Namespace:  Microsoft.Office.Interop.Excel
Assembly:  Microsoft.Office.Interop.Excel (in Microsoft.Office.Interop.Excel.dll)

Syntax

'Declaration
Function Aggregate ( _
    Arg1 As Double, _
    Arg2 As Double, _
    Arg3 As Range, _
    Arg4 As Object, _
    Arg5 As Object, _
    Arg6 As Object, _
    Arg7 As Object, _
    Arg8 As Object, _
    Arg9 As Object, _
    Arg10 As Object, _
    Arg11 As Object, _
    Arg12 As Object, _
    Arg13 As Object, _
    Arg14 As Object, _
    Arg15 As Object, _
    Arg16 As Object, _
    Arg17 As Object, _
    Arg18 As Object, _
    Arg19 As Object, _
    Arg20 As Object, _
    Arg21 As Object, _
    Arg22 As Object, _
    Arg23 As Object, _
    Arg24 As Object, _
    Arg25 As Object, _
    Arg26 As Object, _
    Arg27 As Object, _
    Arg28 As Object, _
    Arg29 As Object, _
    Arg30 As Object _
) As Double
'Usage
Dim instance As WorksheetFunction
Dim Arg1 As Double
Dim Arg2 As Double
Dim Arg3 As Range
Dim Arg4 As Object
Dim Arg5 As Object
Dim Arg6 As Object
Dim Arg7 As Object
Dim Arg8 As Object
Dim Arg9 As Object
Dim Arg10 As Object
Dim Arg11 As Object
Dim Arg12 As Object
Dim Arg13 As Object
Dim Arg14 As Object
Dim Arg15 As Object
Dim Arg16 As Object
Dim Arg17 As Object
Dim Arg18 As Object
Dim Arg19 As Object
Dim Arg20 As Object
Dim Arg21 As Object
Dim Arg22 As Object
Dim Arg23 As Object
Dim Arg24 As Object
Dim Arg25 As Object
Dim Arg26 As Object
Dim Arg27 As Object
Dim Arg28 As Object
Dim Arg29 As Object
Dim Arg30 As Object
Dim returnValue As Double

returnValue = instance.Aggregate(Arg1, _
    Arg2, Arg3, Arg4, Arg5, Arg6, Arg7, _
    Arg8, Arg9, Arg10, Arg11, Arg12, Arg13, _
    Arg14, Arg15, Arg16, Arg17, Arg18, _
    Arg19, Arg20, Arg21, Arg22, Arg23, _
    Arg24, Arg25, Arg26, Arg27, Arg28, _
    Arg29, Arg30)

double Aggregate(
    double Arg1,
    double Arg2,
    Range Arg3,
    Object Arg4,
    Object Arg5,
    Object Arg6,
    Object Arg7,
    Object Arg8,
    Object Arg9,
    Object Arg10,
    Object Arg11,
    Object Arg12,
    Object Arg13,
    Object Arg14,
    Object Arg15,
    Object Arg16,
    Object Arg17,
    Object Arg18,
    Object Arg19,
    Object Arg20,
    Object Arg21,
    Object Arg22,
    Object Arg23,
    Object Arg24,
    Object Arg25,
    Object Arg26,
    Object Arg27,
    Object Arg28,
    Object Arg29,
    Object Arg30
)

Parameters

  • Arg1
    Type: System.Double

    Function_num - A number from 1 to 19 that specifies which function to use.

  • Arg2
    Type: System.Double

    Options - A numerical value that determines which values to ignore in the evaluation range for the function.

  • Arg4
    Type: System.Object

    Ref2 - Ref30 - Numeric arguments 2 to 30 for which you want the aggregate value.

Return Value

Type: System.Double

Remarks

The following constraints apply to the Ref arguments (Arg3 - Arg 30) based on the Function_num value.

Function_num

Ref1

Ref2

Ref3, Ref4, …

1-13

Valid types:

  • Any cell reference

  • Unions

  • Intersections

  • Defined names

  • Structured references

Invalid types:

  • Actual data

  • Arrays

Valid types:

  • Any cell reference

  • Unions

  • Intersections

  • Defined names

  • Structured references

Invalid types:

  • Actual data

  • Arrays

Valid types:

  • Any cell reference

  • Unions

  • Intersections

  • Defined names

  • Structured references

Invalid types:

  • Actual data

  • Arrays

14-17

Valid types:

  • Any cell reference

  • Unions

  • Intersections

  • Defined names

  • Structured references

  • Actual data

  • Arrays

Valid types:

  • Any cell reference

  • Unions

  • Intersections

  • Defined names

  • Structured references

  • Actual data

  • Arrays

No references are allowed

If a second ref argument is required but not provided, AGGREGATE returns a #VALUE! error.

If one or more of the references are 3-D references, AGGREGATE returns the #VALUE! error value.

See Also

Reference

WorksheetFunction Interface

WorksheetFunction Members

Microsoft.Office.Interop.Excel Namespace