SPHelper Class |
This expression variable provides access to SharePoint related functionality within the expression engine.
Inheritance HierarchyNamespace: Colygon.MatchPoint.Core
Assembly: Colygon.MatchPoint (in Colygon.MatchPoint.dll) Version: 2019.2.1.0
SyntaxC#
public static class SPHelper
The SPHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | CombineUrl | Returns the combined URL. |
| ExtractExtension | Returns the file extension extracted from the specified string. |
| ExtractLeafName | Returns the filename part of the specified URL. |
| ExtractParentUrl | Returns the URL of the parent object within the specified URL. |
| GetCurrentList | Returns the current SPList in a non AJAX request. |
| GetCurrentListItem | Returns the current SPListItem in a non AJAX request. |
| GetCurrentUICulture | Returns the current locale ID. |
| GetCurrentUser | Returns the SPUser object of the user currently logged on. |
| GetCurrentWeb | Returns the current SPWeb. |
| GetCurrentZoneUrl | Returns the translated version of the specified URL for the current zone within the SP farm. |
| GetDefaultZoneUrl | Returns the translated version of the specified URL for the default zone within the SP farm. |
| GetEditFormUrl | |
| GetImageFileExtensions | |
| GetList(String) | Returns the SPList with the specified URL. |
| GetList(String, String) | Returns the SPList with the specified parent web URL and list name. |
| GetListItem(String) | Returns the SPListItem with the specified URL. |
| GetListItem(String, String, Int32) | Returns the SPListItem with the specified parent web URL, parent list name and ID. |
| GetListItemDisplayFormUrl | Returns the URL of the 'View Item' form for the specified SPListItem. |
| GetListItemEditFormUrl | Returns the URL of the 'Edit Item' form for the specified SPListItem. |
| GetListNewFormUrl | Returns the URL of the 'New Item' form for the specified SPList. |
| GetOpenDocumentUrl(String) | Returns the 'Open Document' href compatible URL value of the specified file. This can either be an URL (e.g. 'http://foo.com') or a javascript expression (e.g. "javascript:OpenDocument('http://fo.com')". |
| GetOpenDocumentUrl(String, String, String) | Returns the 'Open Document' href compatible URL value of the specified file. This can either be an URL (e.g. 'http://foo.com') or a javascript expression (e.g. "javascript:OpenDocument('http://fo.com')". |
| GetPageUrlPath | Returns the page URL path (SPHelper.GetPageUrlPath) for the current page. |
| GetSendToUrl | |
| GetUniqueFileName | Ensures that the specified fileName does not exist and returns a unique file name if it exists. |
| GetUser | Returns the SPUser object for the specified login name or SDDL SID string. |
| IsJavaScriptUrl(String) | |
| IsJavaScriptUrl(String, String) | |
| OpenWeb(String) | Opens the SPWeb with the specified URL. |
| OpenWeb(String, SPUserToken, Boolean) | |
| ParseOwsUserString | Converts an OWSUSER string (which is retrieved via search) to an object, returns null if input is not in the correct format ('Email | DisplayName | EncodedClaim Claim'). |
| SendMail | Sends an e-mail with the specified recipient, subject and body. The SMTP settings configured in the web application of the current SharePoint site collection are used. |
| TranslateUrl | Returns translated version of the specified URL for the specified zone within the SP farm. |
Fields| Name | Description | |
|---|---|---|
 | JavaScriptPrefix |
Remarks- #APIChange 5.0: removed public static string GetParentFolderUrl(SPListItem item)
- #APIChange 5.0: removed public static SPUser GetUserBySid(string sddlSid), use SPHelper.GetUser() instead
See Also