Class Globals

Inheritance
object
Globals
Inherited Members
Namespace: DotNetNuke.Common
Assembly: DotNetNuke.dll
Syntax
[StandardModule]
public sealed class Globals

Constructors

Globals()

Declaration
public Globals()

Fields

BaseTagRegex

Declaration
public static readonly Regex BaseTagRegex
Field Value
Type Description
Regex

EmailValidatorRegex

Declaration
public static readonly Regex EmailValidatorRegex
Field Value
Type Description
Regex

FileEscapingRegex

Declaration
public static readonly Regex FileEscapingRegex
Field Value
Type Description
Regex

FileExtensionRegex

Declaration
public static readonly Regex FileExtensionRegex
Field Value
Type Description
Regex

FileValidNameRegex

Declaration
public static readonly Regex FileValidNameRegex
Field Value
Type Description
Regex

InvalidCharacters

Declaration
public static readonly Regex InvalidCharacters
Field Value
Type Description
Regex

InvalidInitialCharacters

Declaration
public static readonly Regex InvalidInitialCharacters
Field Value
Type Description
Regex

NonAlphanumericCharacters

Declaration
public static readonly Regex NonAlphanumericCharacters
Field Value
Type Description
Regex

NumberMatchRegex

Declaration
public static readonly Regex NumberMatchRegex
Field Value
Type Description
Regex

ServicesFrameworkRegex

Declaration
public static readonly Regex ServicesFrameworkRegex
Field Value
Type Description
Regex

USERNAME_UNALLOWED_ASCII

Declaration
public static readonly string USERNAME_UNALLOWED_ASCII
Field Value
Type Description
string

glbAboutPage

Declaration
public const string glbAboutPage = "about.htm"
Field Value
Type Description
string

glbAllowControlPanelToDetermineVisibility

Declaration
public const bool glbAllowControlPanelToDetermineVisibility = false
Field Value
Type Description
bool

glbConfigFolder

Declaration
public const string glbConfigFolder = "\\Config\\"
Field Value
Type Description
string

glbContainersPath

Declaration
public const string glbContainersPath = "Portals/_default/Containers/"
Field Value
Type Description
string

glbDefaultControlPanel

Declaration
public const string glbDefaultControlPanel = "Admin/ControlPanel/IconBar.ascx"
Field Value
Type Description
string

glbDefaultPage

Declaration
public const string glbDefaultPage = "Default.aspx"
Field Value
Type Description
string

glbDefaultPane

Declaration
public const string glbDefaultPane = "ContentPane"
Field Value
Type Description
string

glbDotNetNukeConfig

Declaration
public const string glbDotNetNukeConfig = "DotNetNuke.config"
Field Value
Type Description
string

glbEmailRegEx

Declaration
public const string glbEmailRegEx = "^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
Field Value
Type Description
string

glbHostSkinFolder

Declaration
public const string glbHostSkinFolder = "_default"
Field Value
Type Description
string

glbProtectedExtension

Declaration
public const string glbProtectedExtension = ".resources"
Field Value
Type Description
string

glbRoleAllUsers

Declaration
public const string glbRoleAllUsers = "-1"
Field Value
Type Description
string

glbRoleAllUsersName

Declaration
public const string glbRoleAllUsersName = "All Users"
Field Value
Type Description
string

glbRoleNothing

Declaration
public const string glbRoleNothing = "-4"
Field Value
Type Description
string

glbRoleSuperUser

Declaration
public const string glbRoleSuperUser = "-2"
Field Value
Type Description
string

glbRoleSuperUserName

Declaration
public const string glbRoleSuperUserName = "Superuser"
Field Value
Type Description
string

glbRoleUnauthUser

Declaration
public const string glbRoleUnauthUser = "-3"
Field Value
Type Description
string

glbRoleUnauthUserName

Declaration
public const string glbRoleUnauthUserName = "Unauthenticated Users"
Field Value
Type Description
string

glbScriptFormat

Declaration
public const string glbScriptFormat = "<script type=\"text/javascript\" src=\"{0}\" ></script>"
Field Value
Type Description
string

glbSkinsPath

Declaration
public const string glbSkinsPath = "Portals/_default/Skins/"
Field Value
Type Description
string

glbSuperUserAppName

Declaration
public const int glbSuperUserAppName = -1
Field Value
Type Description
int

glbUserNameMinLength

Declaration
public const int glbUserNameMinLength = 5
Field Value
Type Description
int

glbUserNameRegEx

Declaration
public const string glbUserNameRegEx = ""
Field Value
Type Description
string

Properties

ApplicationMapPath

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled removal in v11.0.0.")]
public static string ApplicationMapPath { get; }
Property Value
Type Description
string

ApplicationPath

Declaration
public static string ApplicationPath { get; }
Property Value
Type Description
string

DataBaseVersion

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled removal in v11.0.0.")]
public static Version DataBaseVersion { get; }
Property Value
Type Description
Version

DatabaseEngineVersion

Declaration
public static Version DatabaseEngineVersion { get; set; }
Property Value
Type Description
Version

DesktopModulePath

Declaration
public static string DesktopModulePath { get; }
Property Value
Type Description
string

ElapsedSinceAppStart

Declaration
public static TimeSpan ElapsedSinceAppStart { get; }
Property Value
Type Description
TimeSpan

FormattedNetFrameworkVersion

Declaration
public static string FormattedNetFrameworkVersion { get; }
Property Value
Type Description
string

HostMapPath

Declaration
public static string HostMapPath { get; }
Property Value
Type Description
string

HostPath

Declaration
public static string HostPath { get; }
Property Value
Type Description
string

IISAppName

Declaration
public static string IISAppName { get; set; }
Property Value
Type Description
string

ImageFileTypes

Declaration
public static string ImageFileTypes { get; }
Property Value
Type Description
string

ImagePath

Declaration
public static string ImagePath { get; }
Property Value
Type Description
string

InstallMapPath

Declaration
public static string InstallMapPath { get; }
Property Value
Type Description
string

InstallPath

Declaration
public static string InstallPath { get; }
Property Value
Type Description
string

NETFrameworkVersion

Declaration
public static Version NETFrameworkVersion { get; set; }
Property Value
Type Description
Version

OperatingSystemVersion

Declaration
public static Version OperatingSystemVersion { get; set; }
Property Value
Type Description
Version

ServerName

Declaration
public static string ServerName { get; set; }
Property Value
Type Description
string

Status

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled removal in v11.0.0.")]
public static Globals.UpgradeStatus Status { get; }
Property Value
Type Description
Globals.UpgradeStatus

glbImageFileTypes

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. Use ImageFileTypes instead. Scheduled removal in v11.0.0.")]
public static string glbImageFileTypes { get; }
Property Value
Type Description
string

Methods

AccessDeniedURL()

Declaration
public static string AccessDeniedURL()
Returns
Type Description
string

AccessDeniedURL(string)

Declaration
public static string AccessDeniedURL(string message)
Parameters
Type Name Description
string message
Returns
Type Description
string

AddHTTP(string)

Declaration
public static string AddHTTP(string strURL)
Parameters
Type Name Description
string strURL
Returns
Type Description
string

AddPort(string, string)

Declaration
public static string AddPort(string httpAlias, string originalUrl)
Parameters
Type Name Description
string httpAlias
string originalUrl
Returns
Type Description
string

ApplicationURL()

Declaration
public static string ApplicationURL()
Returns
Type Description
string

ApplicationURL(int)

Declaration
public static string ApplicationURL(int tabID)
Parameters
Type Name Description
int tabID
Returns
Type Description
string

BuildCrossTabDataSet(string, IDataReader, string, string, string, string, string, string, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. No replacement. Scheduled for removal in v11.0.0.")]
public static DataSet BuildCrossTabDataSet(string dataSetName, IDataReader result, string fixedColumns, string variableColumns, string keyColumn, string fieldColumn, string fieldTypeColumn, string stringValueColumn, string numericValueColumn)
Parameters
Type Name Description
string dataSetName
IDataReader result
string fixedColumns
string variableColumns
string keyColumn
string fieldColumn
string fieldTypeColumn
string stringValueColumn
string numericValueColumn
Returns
Type Description
DataSet

BuildCrossTabDataSet(string, IDataReader, string, string, string, string, string, string, string, CultureInfo)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. No replacement. Scheduled for removal in v11.0.0.")]
public static DataSet BuildCrossTabDataSet(string dataSetName, IDataReader result, string fixedColumns, string variableColumns, string keyColumn, string fieldColumn, string fieldTypeColumn, string stringValueColumn, string numericValueColumn, CultureInfo culture)
Parameters
Type Name Description
string dataSetName
IDataReader result
string fixedColumns
string variableColumns
string keyColumn
string fieldColumn
string fieldTypeColumn
string stringValueColumn
string numericValueColumn
CultureInfo culture
Returns
Type Description
DataSet

CleanFileName(string)

Declaration
public static string CleanFileName(string fileName)
Parameters
Type Name Description
string fileName
Returns
Type Description
string

CleanFileName(string, string)

Declaration
public static string CleanFileName(string fileName, string badChars)
Parameters
Type Name Description
string fileName
string badChars
Returns
Type Description
string

CleanFileName(string, string, string)

Declaration
public static string CleanFileName(string fileName, string badChars, string replaceChar)
Parameters
Type Name Description
string fileName
string badChars
string replaceChar
Returns
Type Description
string

CleanName(string)

Declaration
public static string CleanName(string name)
Parameters
Type Name Description
string name
Returns
Type Description
string

CloakText(string)

Declaration
public static string CloakText(string personalInfo)
Parameters
Type Name Description
string personalInfo
Returns
Type Description
string

ConvertDataReaderToDataSet(IDataReader)

Declaration
public static DataSet ConvertDataReaderToDataSet(IDataReader reader)
Parameters
Type Name Description
IDataReader reader
Returns
Type Description
DataSet

ConvertDataReaderToDataTable(IDataReader)

Declaration
public static DataTable ConvertDataReaderToDataTable(IDataReader reader)
Parameters
Type Name Description
IDataReader reader
Returns
Type Description
DataTable

ConvertDataReaderToDataTable(IDataReader, bool)

Declaration
public static DataTable ConvertDataReaderToDataTable(IDataReader reader, bool closeReader)
Parameters
Type Name Description
IDataReader reader
bool closeReader
Returns
Type Description
DataTable

CreateRSS(IDataReader, string, string, string, string, string, string)

Declaration
public static void CreateRSS(IDataReader dr, string titleField, string urlField, string createdDateField, string syndicateField, string domainName, string fileName)
Parameters
Type Name Description
IDataReader dr
string titleField
string urlField
string createdDateField
string syndicateField
string domainName
string fileName

CreateValidClass(string, bool)

Declaration
public static string CreateValidClass(string inputValue, bool validateFirstChar)
Parameters
Type Name Description
string inputValue
bool validateFirstChar
Returns
Type Description
string

CreateValidID(string)

Declaration
public static string CreateValidID(string inputValue)
Parameters
Type Name Description
string inputValue
Returns
Type Description
string

DateToString(DateTime)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. Use DateTime.ToString(\"s\") instead. Scheduled for removal in v11.0.0.")]
public static string DateToString(DateTime dateValue)
Parameters
Type Name Description
DateTime dateValue
Returns
Type Description
string

DeleteFilesRecursive(string, string)

Declaration
public static void DeleteFilesRecursive(string strRoot, string filter)
Parameters
Type Name Description
string strRoot
string filter

DeleteFolderRecursive(string)

Declaration
public static void DeleteFolderRecursive(string strRoot)
Parameters
Type Name Description
string strRoot

DeserializeHashTableBase64(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. No replacement. Scheduled for removal in v11.0.0.")]
public static Hashtable DeserializeHashTableBase64(string source)
Parameters
Type Name Description
string source
Returns
Type Description
Hashtable

DeserializeHashTableXml(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. This API was not meant to be public and only deserializes xml with a root of 'profile'. Scheduled for removal in v11.0.0.")]
public static Hashtable DeserializeHashTableXml(string source)
Parameters
Type Name Description
string source
Returns
Type Description
Hashtable

EncodeReservedCharacters(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. Use System.Net.WebUtility.UrlEncode instead. Scheduled for removal in v11.0.0.")]
public static string EncodeReservedCharacters(string queryString)
Parameters
Type Name Description
string queryString
Returns
Type Description
string

FindControlRecursive(Control, string)

Declaration
public static Control FindControlRecursive(Control objControl, string strControlName)
Parameters
Type Name Description
Control objControl
string strControlName
Returns
Type Description
Control

FindControlRecursiveDown(Control, string)

Declaration
public static Control FindControlRecursiveDown(Control objParent, string strControlName)
Parameters
Type Name Description
Control objParent
string strControlName
Returns
Type Description
Control

FindDatabaseVersion(int, int, int)

Declaration
public static bool FindDatabaseVersion(int major, int minor, int build)
Parameters
Type Name Description
int major
int minor
int build
Returns
Type Description
bool

FormatAddress(object, object, object, object, object, object)

Declaration
public static string FormatAddress(object unit, object street, object city, object region, object country, object postalCode)
Parameters
Type Name Description
object unit
object street
object city
object region
object country
object postalCode
Returns
Type Description
string

FormatEmail(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. This function has been replaced by DotNetNuke.Common.Utilities.HtmlUtils.FormatEmail. Scheduled for removal in v11.0.0.")]
public static string FormatEmail(string email)
Parameters
Type Name Description
string email
Returns
Type Description
string

FormatHelpUrl(string, PortalSettings, string)

Declaration
public static string FormatHelpUrl(string helpUrl, PortalSettings objPortalSettings, string name)
Parameters
Type Name Description
string helpUrl
PortalSettings objPortalSettings
string name
Returns
Type Description
string

FormatHelpUrl(string, PortalSettings, string, string)

Declaration
public static string FormatHelpUrl(string helpUrl, PortalSettings objPortalSettings, string name, string version)
Parameters
Type Name Description
string helpUrl
PortalSettings objPortalSettings
string name
string version
Returns
Type Description
string

FormatVersion(Version)

Declaration
public static string FormatVersion(Version version)
Parameters
Type Name Description
Version version
Returns
Type Description
string

FormatVersion(Version, bool)

Declaration
public static string FormatVersion(Version version, bool includeBuild)
Parameters
Type Name Description
Version version
bool includeBuild
Returns
Type Description
string

FormatVersion(Version, string, int, string)

Declaration
public static string FormatVersion(Version version, string fieldFormat, int fieldCount, string delimiterCharacter)
Parameters
Type Name Description
Version version
string fieldFormat
int fieldCount
string delimiterCharacter
Returns
Type Description
string

FormatWebsite(object)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. This function has been replaced by DotNetNuke.Common.Utilities.HtmlUtils.FormatWebsite. Scheduled for removal in v11.0.0.")]
public static string FormatWebsite(object website)
Parameters
Type Name Description
object website
Returns
Type Description
string

FriendlyUrl(TabInfo, string)

Declaration
public static string FriendlyUrl(TabInfo tab, string path)
Parameters
Type Name Description
TabInfo tab
string path
Returns
Type Description
string

FriendlyUrl(TabInfo, string, IPortalSettings)

Declaration
public static string FriendlyUrl(TabInfo tab, string path, IPortalSettings settings)
Parameters
Type Name Description
TabInfo tab
string path
IPortalSettings settings
Returns
Type Description
string

FriendlyUrl(TabInfo, string, PortalSettings)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.3. Use the IPortalSettings overload. Scheduled for removal in v11.0.0.")]
public static string FriendlyUrl(TabInfo tab, string path, PortalSettings settings)
Parameters
Type Name Description
TabInfo tab
string path
PortalSettings settings
Returns
Type Description
string

FriendlyUrl(TabInfo, string, string)

Declaration
public static string FriendlyUrl(TabInfo tab, string path, string pageName)
Parameters
Type Name Description
TabInfo tab
string path
string pageName
Returns
Type Description
string

FriendlyUrl(TabInfo, string, string, IPortalSettings)

Declaration
public static string FriendlyUrl(TabInfo tab, string path, string pageName, IPortalSettings settings)
Parameters
Type Name Description
TabInfo tab
string path
string pageName
IPortalSettings settings
Returns
Type Description
string

FriendlyUrl(TabInfo, string, string, PortalSettings)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.3. Use the IPortalSettings overload. Scheduled for removal in v11.0.0.")]
public static string FriendlyUrl(TabInfo tab, string path, string pageName, PortalSettings settings)
Parameters
Type Name Description
TabInfo tab
string path
string pageName
PortalSettings settings
Returns
Type Description
string

FriendlyUrl(TabInfo, string, string, string)

Declaration
public static string FriendlyUrl(TabInfo tab, string path, string pageName, string portalAlias)
Parameters
Type Name Description
TabInfo tab
string path
string pageName
string portalAlias
Returns
Type Description
string

GenerateTabPath(int, string)

Declaration
public static string GenerateTabPath(int parentId, string tabName)
Parameters
Type Name Description
int parentId
string tabName
Returns
Type Description
string

GetAbsoluteServerPath(HttpRequest)

Declaration
public static string GetAbsoluteServerPath(HttpRequest request)
Parameters
Type Name Description
HttpRequest request
Returns
Type Description
string

GetApplicationName()

Declaration
public static string GetApplicationName()
Returns
Type Description
string

GetApplicationName(int)

Declaration
public static string GetApplicationName(int portalID)
Parameters
Type Name Description
int portalID
Returns
Type Description
string

GetContent(string, string)

Declaration
public static XmlNode GetContent(string content, string contentType)
Parameters
Type Name Description
string content
string contentType
Returns
Type Description
XmlNode

GetDBConnectionString()

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. This function has been replaced by DotNetNuke.Common.Utilities.Config.GetConnectionString. Scheduled for removal in v11.0.0.")]
public static string GetDBConnectionString()
Returns
Type Description
string

GetDomainName(HttpRequest)

Declaration
public static string GetDomainName(HttpRequest request)
Parameters
Type Name Description
HttpRequest request
Returns
Type Description
string

GetDomainName(HttpRequest, bool)

Declaration
public static string GetDomainName(HttpRequest request, bool parsePortNumber)
Parameters
Type Name Description
HttpRequest request
bool parsePortNumber
Returns
Type Description
string

GetDomainName(HttpRequestBase)

Declaration
public static string GetDomainName(HttpRequestBase request)
Parameters
Type Name Description
HttpRequestBase request
Returns
Type Description
string

GetDomainName(HttpRequestBase, bool)

Declaration
public static string GetDomainName(HttpRequestBase request, bool parsePortNumber)
Parameters
Type Name Description
HttpRequestBase request
bool parsePortNumber
Returns
Type Description
string

GetExternalRequest(string)

Declaration
public static HttpWebRequest GetExternalRequest(string address)
Parameters
Type Name Description
string address
Returns
Type Description
HttpWebRequest

GetExternalRequest(string, NetworkCredential)

Declaration
public static HttpWebRequest GetExternalRequest(string address, NetworkCredential credentials)
Parameters
Type Name Description
string address
NetworkCredential credentials
Returns
Type Description
HttpWebRequest

GetFileList()

Declaration
public static ArrayList GetFileList()
Returns
Type Description
ArrayList

GetFileList(DirectoryInfo, string, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. No replacement. Scheduled for removal in v11.0.0.")]
public static ArrayList GetFileList(DirectoryInfo currentDirectory, string strExtensions = "", bool noneSpecified = true)
Parameters
Type Name Description
DirectoryInfo currentDirectory
string strExtensions
bool noneSpecified
Returns
Type Description
ArrayList

GetFileList(int)

Declaration
public static ArrayList GetFileList(int portalId)
Parameters
Type Name Description
int portalId
Returns
Type Description
ArrayList

GetFileList(int, string)

Declaration
public static ArrayList GetFileList(int portalId, string strExtensions)
Parameters
Type Name Description
int portalId
string strExtensions
Returns
Type Description
ArrayList

GetFileList(int, string, bool)

Declaration
public static ArrayList GetFileList(int portalId, string strExtensions, bool noneSpecified)
Parameters
Type Name Description
int portalId
string strExtensions
bool noneSpecified
Returns
Type Description
ArrayList

GetFileList(int, string, bool, string)

Declaration
public static ArrayList GetFileList(int portalId, string strExtensions, bool noneSpecified, string folder)
Parameters
Type Name Description
int portalId
string strExtensions
bool noneSpecified
string folder
Returns
Type Description
ArrayList

GetFileList(int, string, bool, string, bool)

Declaration
public static ArrayList GetFileList(int portalId, string strExtensions, bool noneSpecified, string folder, bool includeHidden)
Parameters
Type Name Description
int portalId
string strExtensions
bool noneSpecified
string folder
bool includeHidden
Returns
Type Description
ArrayList

GetHashValue(object, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. No replacement. Scheduled for removal in v11.0.0.")]
public static string GetHashValue(object hashObject, string defaultValue)
Parameters
Type Name Description
object hashObject
string defaultValue
Returns
Type Description
string

GetHelpText(int)

Declaration
public static string GetHelpText(int moduleControlId)
Parameters
Type Name Description
int moduleControlId
Returns
Type Description
string

GetHostPortalSettings()

Declaration
public static PortalSettings GetHostPortalSettings()
Returns
Type Description
PortalSettings

GetLastAppliedIteration(Version)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled for removal in v11.0.0.")]
public static int GetLastAppliedIteration(Version version)
Parameters
Type Name Description
Version version
Returns
Type Description
int

GetMediumDate(string)

Declaration
public static string GetMediumDate(string strDate)
Parameters
Type Name Description
string strDate
Returns
Type Description
string

GetOnLineHelp(string)

Declaration
public static string GetOnLineHelp(string helpUrl)
Parameters
Type Name Description
string helpUrl
Returns
Type Description
string

GetOnLineHelp(string, ModuleInfo)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. ModuleInfo is unused, use the overload that does not take a ModuleInfo. Scheduled for removal in v11.0.0.")]
public static string GetOnLineHelp(string helpUrl, ModuleInfo moduleConfig)
Parameters
Type Name Description
string helpUrl
ModuleInfo moduleConfig
Returns
Type Description
string

GetPortalDomainName(string, HttpRequest, bool)

Declaration
public static string GetPortalDomainName(string strPortalAlias, HttpRequest request, bool blnAddHTTP)
Parameters
Type Name Description
string strPortalAlias
HttpRequest request
bool blnAddHTTP
Returns
Type Description
string

GetPortalSettings()

Declaration
public static PortalSettings GetPortalSettings()
Returns
Type Description
PortalSettings

GetRoleName(int)

Declaration
public static string GetRoleName(int roleId)
Parameters
Type Name Description
int roleId
Returns
Type Description
string

GetShortDate(string)

Declaration
public static string GetShortDate(string strDate)
Parameters
Type Name Description
string strDate
Returns
Type Description
string

GetSubFolderPath(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Replaced by GetSubFolderPath(string strFileNamePath, int portalId). Scheduled for removal in v11.0.0.")]
public static string GetSubFolderPath(string strFileNamePath)
Parameters
Type Name Description
string strFileNamePath
Returns
Type Description
string

GetSubFolderPath(string, int)

Declaration
public static string GetSubFolderPath(string strFileNamePath, int portalId)
Parameters
Type Name Description
string strFileNamePath
int portalId
Returns
Type Description
string

GetTotalRecords(ref IDataReader)

Declaration
public static int GetTotalRecords(ref IDataReader dr)
Parameters
Type Name Description
IDataReader dr
Returns
Type Description
int

GetURLType(string)

Declaration
public static TabType GetURLType(string url)
Parameters
Type Name Description
string url
Returns
Type Description
TabType

HTTPPOSTEncode(string)

Declaration
public static string HTTPPOSTEncode(string strPost)
Parameters
Type Name Description
string strPost
Returns
Type Description
string

ImportFile(int, string)

Declaration
public static string ImportFile(int portalId, string url)
Parameters
Type Name Description
int portalId
string url
Returns
Type Description
string

ImportUrl(int, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. moduleId is not used in the method, use the overload that takes only the url. Scheduled for removal in v11.0.0.")]
public static string ImportUrl(int moduleId, string url)
Parameters
Type Name Description
int moduleId
string url
Returns
Type Description
string

ImportUrl(string)

Declaration
public static string ImportUrl(string url)
Parameters
Type Name Description
string url
Returns
Type Description
string

IncrementalVersionExists(Version)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled for removal in v11.0.0.")]
public static bool IncrementalVersionExists(Version version)
Parameters
Type Name Description
Version version
Returns
Type Description
bool

IsAdminControl()

Declaration
public static bool IsAdminControl()
Returns
Type Description
bool

IsAdminSkin()

Declaration
public static bool IsAdminSkin()
Returns
Type Description
bool

IsEditMode()

Declaration
public static bool IsEditMode()
Returns
Type Description
bool

IsHostTab(int)

Declaration
public static bool IsHostTab(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
bool

IsLayoutMode()

Declaration
public static bool IsLayoutMode()
Returns
Type Description
bool

LinkClick(string, int, int)

Declaration
public static string LinkClick(string link, int tabId, int moduleId)
Parameters
Type Name Description
string link
int tabId
int moduleId
Returns
Type Description
string

LinkClick(string, int, int, bool)

Declaration
public static string LinkClick(string link, int tabId, int moduleId, bool trackClicks)
Parameters
Type Name Description
string link
int tabId
int moduleId
bool trackClicks
Returns
Type Description
string

LinkClick(string, int, int, bool, bool)

Declaration
public static string LinkClick(string link, int tabId, int moduleId, bool trackClicks, bool forceDownload)
Parameters
Type Name Description
string link
int tabId
int moduleId
bool trackClicks
bool forceDownload
Returns
Type Description
string

LinkClick(string, int, int, bool, bool, int, bool, string)

Declaration
public static string LinkClick(string link, int tabId, int moduleId, bool trackClicks, bool forceDownload, int portalId, bool enableUrlLanguage, string portalGuid)
Parameters
Type Name Description
string link
int tabId
int moduleId
bool trackClicks
bool forceDownload
int portalId
bool enableUrlLanguage
string portalGuid
Returns
Type Description
string

LinkClick(string, int, int, bool, string)

Declaration
public static string LinkClick(string link, int tabId, int moduleId, bool trackClicks, string contentType)
Parameters
Type Name Description
string link
int tabId
int moduleId
bool trackClicks
string contentType
Returns
Type Description
string

LinkClickURL(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Use Common.Globals.LinkClick() for proper handling of URLs. Scheduled for removal in v11.0.0.")]
public static string LinkClickURL(string link)
Parameters
Type Name Description
string link
Returns
Type Description
string

LoginURL(string, bool)

Declaration
public static string LoginURL(string returnUrl, bool overrideSetting)
Parameters
Type Name Description
string returnUrl
bool overrideSetting
Returns
Type Description
string

LoginURL(string, bool, IPortalSettings)

Declaration
public static string LoginURL(string returnUrl, bool overrideSetting, IPortalSettings portalSettings)
Parameters
Type Name Description
string returnUrl
bool overrideSetting
IPortalSettings portalSettings
Returns
Type Description
string

LoginURL(string, bool, PortalSettings)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. Use the overload that takes IPortalSettings instead. Scheduled for removal in v11.0.0.")]
public static string LoginURL(string returnUrl, bool overrideSetting, PortalSettings portalSettings)
Parameters
Type Name Description
string returnUrl
bool overrideSetting
PortalSettings portalSettings
Returns
Type Description
string

ManageTokenUploadDirectory(string, string, string)

Declaration
public static string ManageTokenUploadDirectory(string strHTML, string strUploadDirectory, string strToken)
Parameters
Type Name Description
string strHTML
string strUploadDirectory
string strToken
Returns
Type Description
string

ManageUploadDirectory(string, string)

Declaration
public static string ManageUploadDirectory(string strHTML, string strUploadDirectory)
Parameters
Type Name Description
string strHTML
string strUploadDirectory
Returns
Type Description
string

NavigateURL()

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL()
Returns
Type Description
string

NavigateURL(int)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(int tabID)
Parameters
Type Name Description
int tabID
Returns
Type Description
string

NavigateURL(int, PortalSettings, string, params string[])

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(int tabID, PortalSettings settings, string controlKey, params string[] additionalParameters)
Parameters
Type Name Description
int tabID
PortalSettings settings
string controlKey
string[] additionalParameters
Returns
Type Description
string

NavigateURL(int, bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(int tabID, bool isSuperTab)
Parameters
Type Name Description
int tabID
bool isSuperTab
Returns
Type Description
string

NavigateURL(int, bool, PortalSettings, string, string, string, params string[])

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
public static string NavigateURL(int tabID, bool isSuperTab, PortalSettings settings, string controlKey, string language, string pageName, params string[] additionalParameters)
Parameters
Type Name Description
int tabID
bool isSuperTab
PortalSettings settings
string controlKey
string language
string pageName
string[] additionalParameters
Returns
Type Description
string

NavigateURL(int, bool, PortalSettings, string, string, params string[])

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
public static string NavigateURL(int tabID, bool isSuperTab, PortalSettings settings, string controlKey, string language, params string[] additionalParameters)
Parameters
Type Name Description
int tabID
bool isSuperTab
PortalSettings settings
string controlKey
string language
string[] additionalParameters
Returns
Type Description
string

NavigateURL(int, bool, PortalSettings, string, params string[])

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(int tabID, bool isSuperTab, PortalSettings settings, string controlKey, params string[] additionalParameters)
Parameters
Type Name Description
int tabID
bool isSuperTab
PortalSettings settings
string controlKey
string[] additionalParameters
Returns
Type Description
string

NavigateURL(int, string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(int tabID, string controlKey)
Parameters
Type Name Description
int tabID
string controlKey
Returns
Type Description
string

NavigateURL(int, string, params string[])

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(int tabID, string controlKey, params string[] additionalParameters)
Parameters
Type Name Description
int tabID
string controlKey
string[] additionalParameters
Returns
Type Description
string

NavigateURL(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(string controlKey)
Parameters
Type Name Description
string controlKey
Returns
Type Description
string

NavigateURL(string, params string[])

Declaration
[Obsolete("Deprecated in DotNetNuke 9.4.2. Use INavigationManager via dependency injection. Scheduled for removal in v11.0.0.")]
[Browsable(false)]
public static string NavigateURL(string controlKey, params string[] additionalParameters)
Parameters
Type Name Description
string controlKey
string[] additionalParameters
Returns
Type Description
string

PreventSQLInjection(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. Use Security Filter functions in the PortalSecurity class. Scheduled for removal in v11.0.0.")]
public static string PreventSQLInjection(string strSQL)
Parameters
Type Name Description
string strSQL
Returns
Type Description
string

QueryStringDecode(string)

Declaration
public static string QueryStringDecode(string queryString)
Parameters
Type Name Description
string queryString
Returns
Type Description
string

QueryStringEncode(string)

Declaration
public static string QueryStringEncode(string queryString)
Parameters
Type Name Description
string queryString
Returns
Type Description
string

Redirect(string, bool)

Declaration
public static void Redirect(string url, bool endResponse)
Parameters
Type Name Description
string url
bool endResponse

RegisterURL(string, string)

Declaration
public static string RegisterURL(string returnURL, string originalURL)
Parameters
Type Name Description
string returnURL
string originalURL
Returns
Type Description
string

ResolveUrl(string)

Declaration
public static string ResolveUrl(string url)
Parameters
Type Name Description
string url
Returns
Type Description
string

SerializeHashTableBase64(Hashtable)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. No replacement. Scheduled for removal in v11.0.0.")]
public static string SerializeHashTableBase64(Hashtable source)
Parameters
Type Name Description
Hashtable source
Returns
Type Description
string

SerializeHashTableXml(Hashtable)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.8.1. This method was never meant to be public and only works for 'profile' root namespace. Scheduled for removal in v11.0.0.")]
public static string SerializeHashTableXml(Hashtable source)
Parameters
Type Name Description
Hashtable source
Returns
Type Description
string

SetApplicationName(int)

Declaration
public static void SetApplicationName(int portalId)
Parameters
Type Name Description
int portalId

SetApplicationName(string)

Declaration
public static void SetApplicationName(string applicationName)
Parameters
Type Name Description
string applicationName

SetFormFocus(Control)

Declaration
public static void SetFormFocus(Control control)
Parameters
Type Name Description
Control control

SetStatus(UpgradeStatus)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled for removal in v11.0.0.")]
public static void SetStatus(Globals.UpgradeStatus status)
Parameters
Type Name Description
Globals.UpgradeStatus status

UpdateDataBaseVersion(Version)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled for removal in v11.0.0.")]
public static void UpdateDataBaseVersion(Version version)
Parameters
Type Name Description
Version version

UpdateDataBaseVersionIncrement(Version, int)

Declaration
[Obsolete("Deprecated in DotNetNuke 9.7.1. Use Dependency Injection to resolve 'DotNetNuke.Abstractions.IApplicationStatusInfo' instead. Scheduled for removal in v11.0.0.")]
public static void UpdateDataBaseVersionIncrement(Version version, int increment)
Parameters
Type Name Description
Version version
int increment

UsePortNumber()

Declaration
public static bool UsePortNumber()
Returns
Type Description
bool

UserProfilePicFormattedUrl()

Declaration
[Obsolete("Deprecated in DotNetNuke 7.3.0. It causes issues in SSL-offloading scenarios - please use UserProfilePicRelativeUrl instead. Scheduled for removal in v11.0.0.")]
public static string UserProfilePicFormattedUrl()
Returns
Type Description
string

UserProfilePicRelativeUrl()

Declaration
[Obsolete("Deprecated in DotNetNuke 8.0.0. Please use UserController.Instance.GetUserProfilePictureUrl. Scheduled for removal in v11.0.0.")]
public static string UserProfilePicRelativeUrl()
Returns
Type Description
string

UserProfilePicRelativeUrl(bool)

Declaration
[Obsolete("Deprecated in DotNetNuke 8.0.0. Please use UserController.Instance.GetUserProfilePictureUrl. Scheduled for removal in v11.0.0.")]
public static string UserProfilePicRelativeUrl(bool includeCdv)
Parameters
Type Name Description
bool includeCdv
Returns
Type Description
string

UserProfileURL(int)

Declaration
public static string UserProfileURL(int userId)
Parameters
Type Name Description
int userId
Returns
Type Description
string

ValidateLoginTabID(int)

Declaration
public static bool ValidateLoginTabID(int tabId)
Parameters
Type Name Description
int tabId
Returns
Type Description
bool

ValidateModuleInTab(int, string)

Declaration
public static bool ValidateModuleInTab(int tabId, string moduleName)
Parameters
Type Name Description
int tabId
string moduleName
Returns
Type Description
bool

XMLEncode(string)

Declaration
[Obsolete("Deprecated in DotNetNuke 7.0.0. This function has been replaced by DotNetNuke.Common.Utilities.XmlUtils.XMLEncode. Scheduled for removal in v11.0.0.")]
public static string XMLEncode(string html)
Parameters
Type Name Description
string html
Returns
Type Description
string

Extension Methods