TransformationHelperGetSharePointFileUrl Method |
Gets URL for accessing file on SharePoint server.
Namespace: CMS.ControlsAssembly: CMS.Controls (in CMS.Controls.dll) Version: 9.0.0
Syntaxpublic 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: SystemString
Code name of SharePoint connection to be used. - fileRef
- Type: SystemString
SharePoint server path to file. - cacheMinutes (Optional)
- Type: SystemNullableInt32
How long should the file be cached (after accessing the URL). Blank uses the Settings value, 0 means no cache. - cacheFileSize (Optional)
- Type: SystemNullableInt32
The maximum size of file the will be cached. Blank uses the Settings value. - width (Optional)
- Type: SystemNullableInt32
Maximum width of the image the handler should return. - height (Optional)
- Type: SystemNullableInt32
Maximum height of the image the handler should return. - maxSideSize (Optional)
- Type: SystemNullableInt32
Maximum side size of the image the handler should return.
Return Value
Type:
StringURL on which the file can be accessed.
See Also