Web.MapToIcon method

Returns the name of the image file for the icon that is used to represent the specified file.

Namespace:  Microsoft.SharePoint.Client
Assembly:  Microsoft.SharePoint.Client (in Microsoft.SharePoint.Client.dll)

Syntax

'Declaration
Public Function MapToIcon ( _
    fileName As String, _
    progId As String, _
    size As IconSize _
) As ClientResult(Of String)
'Usage
Dim instance As Web
Dim fileName As String
Dim progId As String
Dim size As IconSize
Dim returnValue As ClientResult(Of String)

returnValue = instance.MapToIcon(fileName, _
    progId, size)

public ClientResult<string> MapToIcon(
    string fileName,
    string progId,
    IconSize size
)

Parameters

• fileName
  Type: System.String

  Specifies the name of the file which is used to determine the image file name.

  If a a null reference (Nothing in Visual Basic) or empty string is passed into this parameter, the protocol server must return an empty string.

• progId
  Type: System.String

  Specifies the ProgID of the application that was used to create the file.

  If the value of this parameter is a null reference (Nothing in Visual Basic) or an empty string, the protocol server must provide the name of the image file based on the specified fileName.

• size
  Type: Microsoft.SharePoint.Client.Utilities.IconSize

  Specifies the icon size.

Return value

Type: Microsoft.SharePoint.Client.ClientResult<String>
Returns a ClientResult<T> instance representing the name of the image file for the icon that is used to represent the specified file.

See also

Reference

Web class

Web members

Microsoft.SharePoint.Client namespace