SharePointUrlProvider.GetSharePointFileUrl Method

Gets the URL for a file at the SharePoint server.

Namespace: CMS.SharePoint
Assembly: CMS.SharePoint (in CMS.SharePoint.dll) Version: 13.0.131

Syntax

public string GetSharePointFileUrl(
	string filePath,
	Nullable<int> width = null,
	Nullable<int> height = null,
	Nullable<int> maxSideSize = null
)

Parameters

filePath

Type: System.String
The SharePoint server path to file in the format "/<appName>/<filePath>"

width (Optional)

Type: System.Nullable<Int32>
Maximum width (px) of the image the handler should return.

height (Optional)

Type: System.Nullable<Int32>
Maximum height (px) of the image the handler should return.

maxSideSize (Optional)

Type: System.Nullable<Int32>
Maximum side size (px) of the image the handler should return.

Return Value

Type: String
The URL which the file can be accessed at.

Implements

ISharePointUrlProvider.GetSharePointFileUrl(String, Nullable<Int32>, Nullable<Int32>, Nullable<Int32>)

Exceptions

Exception	Condition
ArgumentNullException	filePath is null.
ArgumentException	filePath is empty string.