TransformationHelper.GetSharePointFileUrl Method

Gets URL for accessing file on SharePoint server.

Namespace: CMS.DocumentEngine.Web.UI
Assembly: CMS.DocumentEngine.Web.UI (in CMS.DocumentEngine.Web.UI.dll) Version: 12.0.0

Syntax

public string GetSharePointFileUrl(
	string connectionName,
	string fileRef,
	Nullable<int> cacheMinutes = null,
	Nullable<int> cacheFileSize = null,
	Nullable<int> width = null,
	Nullable<int> height = null,
	Nullable<int> maxSideSize = null
)

Parameters

connectionName

Type: System.String
Code name of SharePoint connection to be used.

fileRef

Type: System.String
SharePoint server path to file.

cacheMinutes (Optional)

Type: System.Nullable<Int32>
How long should the file be cached (after accessing the URL). Blank uses the Settings value, 0 means no cache.

cacheFileSize (Optional)

Type: System.Nullable<Int32>
The maximum size of file the will be cached. Blank uses the Settings value.

width (Optional)

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

height (Optional)

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

maxSideSize (Optional)

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

Return Value

Type: String
URL on which the file can be accessed.