SPUtility.FormatStringWithListType Method (String, SPList, Boolean)

Format a string by inserting the name that corresponds to a list’s SPBaseType, optionally converting the type name to lowercase.

Namespace:  Microsoft.SharePoint.Utilities
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)
Available in Sandboxed Solutions: Yes
Available in SharePoint Online

Syntax

'Declaration
Public Shared Function FormatStringWithListType ( _
    format As String, _
    list As SPList, _
    bInLowerCase As Boolean _
) As String
'Usage
Dim format As String
Dim list As SPList
Dim bInLowerCase As Boolean
Dim returnValue As String

returnValue = SPUtility.FormatStringWithListType(format, _
    list, bInLowerCase)

public static string FormatStringWithListType(
    string format,
    SPList list,
    bool bInLowerCase
)

Parameters

• format
  Type: System.String

  The string to format.

• list
  Type: Microsoft.SharePoint.SPList

  The list whose type name to insert.

• bInLowerCase
  Type: System.Boolean

  true to convert to lowercase; otherwise, false.

Return Value

Type: System.String
The formatted string.

See Also

Reference

SPUtility Class

SPUtility Members

FormatStringWithListType Overload

Microsoft.SharePoint.Utilities Namespace