Share via


GridHeaderUtils.GetRootMostHeaderOfType method

Returns the top-level header of a specified type from a list of headers.

Namespace:  Microsoft.PerformancePoint.Scorecards
Assembly:  Microsoft.PerformancePoint.Scorecards.Client (in Microsoft.PerformancePoint.Scorecards.Client.dll)

Syntax

'Declaration
Public Shared Function GetRootMostHeaderOfType ( _
    headers As List(Of GridHeaderItem), _
    headerType As ScorecardNodeTypes _
) As GridHeaderItem
'Usage
Dim headers As List(Of GridHeaderItem)
Dim headerType As ScorecardNodeTypes
Dim returnValue As GridHeaderItem

returnValue = GridHeaderUtils.GetRootMostHeaderOfType(headers, _
    headerType)
public static GridHeaderItem GetRootMostHeaderOfType(
    List<GridHeaderItem> headers,
    ScorecardNodeTypes headerType
)

Parameters

Return value

Type: Microsoft.PerformancePoint.Scorecards.GridHeaderItem
The top-level header of the specified type from the list, if found; otherwise, a null reference (Nothing in Visual Basic).

Exceptions

Exception Condition
NullReferenceException

Thrown when headers is null.

Remarks

The headerType parameter can be the bit-wise combination of multiple types.

See also

Reference

GridHeaderUtils class

GridHeaderUtils members

Microsoft.PerformancePoint.Scorecards namespace