Class Config

Inheritance

object

Config

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: DotNetNuke.Common.Utilities

Assembly: DotNetNuke.dll

Syntax

public class Config

Constructors

Config()

Declaration

public Config()

Methods

AddAppSetting(XmlDocument, string, string)

Declaration

public static XmlDocument AddAppSetting(XmlDocument xmlDoc, string key, string value)

Parameters

Type	Name	Description
XmlDocument	xmlDoc
string	key
string	value

Returns

Type	Description
XmlDocument

AddAppSetting(XmlDocument, string, string, bool)

Declaration

public static XmlDocument AddAppSetting(XmlDocument xmlDoc, string key, string value, bool update)

Parameters

Type	Name	Description
XmlDocument	xmlDoc
string	key
string	value
bool	update

Returns

Type	Description
XmlDocument

AddCodeSubDirectory(IApplicationStatusInfo, string)

Declaration

public static void AddCodeSubDirectory(IApplicationStatusInfo appStatus, string name)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
string	name

AddCodeSubDirectory(string)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static void AddCodeSubDirectory(string name)

Parameters

Type	Name	Description
string	name

AddFCNMode(IApplicationStatusInfo, FcnMode)

Declaration

public static string AddFCNMode(IApplicationStatusInfo appStatus, Config.FcnMode fcnMode)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
Config.FcnMode	fcnMode

Returns

Type	Description
string

AddFCNMode(FcnMode)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string AddFCNMode(Config.FcnMode fcnMode)

Parameters

Type	Name	Description
Config.FcnMode	fcnMode

Returns

Type	Description
string

BackupConfig()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static void BackupConfig()

BackupConfig(IApplicationStatusInfo)

Declaration

public static void BackupConfig(IApplicationStatusInfo statusInfo)

Parameters

Type	Name	Description
IApplicationStatusInfo	statusInfo

GetAuthCookieTimeout()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static int GetAuthCookieTimeout()

Returns

Type	Description
int

GetAuthCookieTimeout(IApplicationStatusInfo)

Declaration

public static int GetAuthCookieTimeout(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
int

GetConnectionString()

Declaration

public static string GetConnectionString()

Returns

Type	Description
string

GetConnectionString(string)

Declaration

public static string GetConnectionString(string name)

Parameters

Type	Name	Description
string	name

Returns

Type	Description
string

GetCustomErrorMode()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string GetCustomErrorMode()

Returns

Type	Description
string

GetCustomErrorMode(IApplicationStatusInfo)

Declaration

public static string GetCustomErrorMode(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
string

GetDataBaseOwner()

Declaration

public static string GetDataBaseOwner()

Returns

Type	Description
string

GetDecryptionkey()

Declaration

public static string GetDecryptionkey()

Returns

Type	Description
string

GetDefaultProvider(string)

Declaration

public static Provider GetDefaultProvider(string type)

Parameters

Type	Name	Description
string	type

Returns

Type	Description
Provider

GetFcnMode()

Declaration

public static string GetFcnMode()

Returns

Type	Description
string

GetFriendlyUrlProvider()

Declaration

public static string GetFriendlyUrlProvider()

Returns

Type	Description
string

GetMaxUploadSize()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static long GetMaxUploadSize()

Returns

Type	Description
long

GetMaxUploadSize(IApplicationStatusInfo)

Declaration

public static long GetMaxUploadSize(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
long

GetObjectQualifer()

Declaration

public static string GetObjectQualifer()

Returns

Type	Description
string

GetPathToFile(IApplicationStatusInfo, ConfigFileType)

Declaration

public static string GetPathToFile(IApplicationStatusInfo appStatus, Config.ConfigFileType file)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
Config.ConfigFileType	file

Returns

Type	Description
string

GetPathToFile(IApplicationStatusInfo, ConfigFileType, bool)

Declaration

public static string GetPathToFile(IApplicationStatusInfo appStatus, Config.ConfigFileType file, bool overwrite)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
Config.ConfigFileType	file
bool	overwrite

Returns

Type	Description
string

GetPathToFile(ConfigFileType)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string GetPathToFile(Config.ConfigFileType file)

Parameters

Type	Name	Description
Config.ConfigFileType	file

Returns

Type	Description
string

GetPathToFile(ConfigFileType, bool)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string GetPathToFile(Config.ConfigFileType file, bool overwrite)

Parameters

Type	Name	Description
Config.ConfigFileType	file
bool	overwrite

Returns

Type	Description
string

GetPersistentCookieTimeout()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static int GetPersistentCookieTimeout()

Returns

Type	Description
int

GetPersistentCookieTimeout(IApplicationStatusInfo)

Declaration

public static int GetPersistentCookieTimeout(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
int

GetProvider(string, string)

Declaration

public static Provider GetProvider(string type, string name)

Parameters

Type	Name	Description
string	type
string	name

Returns

Type	Description
Provider

GetProviderPath(string)

Declaration

public static string GetProviderPath(string type)

Parameters

Type	Name	Description
string	type

Returns

Type	Description
string

GetRequestFilterSize()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static long GetRequestFilterSize()

Returns

Type	Description
long

GetRequestFilterSize(IApplicationStatusInfo)

Declaration

public static long GetRequestFilterSize(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
long

GetSection(string)

Declaration

public static object GetSection(string section)

Parameters

Type	Name	Description
string	section

Returns

Type	Description
object

GetSetting(string)

Declaration

public static string GetSetting(string setting)

Parameters

Type	Name	Description
string	setting

Returns

Type	Description
string

GetUpgradeConnectionString()

Declaration

public static string GetUpgradeConnectionString()

Returns

Type	Description
string

IsNet45OrNewer()

Declaration

public static bool IsNet45OrNewer()

Returns

Type	Description
bool

Load()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static XmlDocument Load()

Returns

Type	Description
XmlDocument

Load(IApplicationStatusInfo)

Declaration

public static XmlDocument Load(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
XmlDocument

Load(IApplicationStatusInfo, string)

Declaration

public static XmlDocument Load(IApplicationStatusInfo appStatus, string filename)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
string	filename

Returns

Type	Description
XmlDocument

Load(string)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static XmlDocument Load(string filename)

Parameters

Type	Name	Description
string	filename

Returns

Type	Description
XmlDocument

RemoveCodeSubDirectory(IApplicationStatusInfo, string)

Declaration

public static void RemoveCodeSubDirectory(IApplicationStatusInfo appStatus, string name)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
string	name

RemoveCodeSubDirectory(string)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static void RemoveCodeSubDirectory(string name)

Parameters

Type	Name	Description
string	name

Save(IApplicationStatusInfo, XmlDocument)

Declaration

public static string Save(IApplicationStatusInfo appStatus, XmlDocument xmlDoc)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
XmlDocument	xmlDoc

Returns

Type	Description
string

Save(IApplicationStatusInfo, XmlDocument, string)

Declaration

public static string Save(IApplicationStatusInfo appStatus, XmlDocument xmlDoc, string filename)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
XmlDocument	xmlDoc
string	filename

Returns

Type	Description
string

Save(XmlDocument)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string Save(XmlDocument xmlDoc)

Parameters

Type	Name	Description
XmlDocument	xmlDoc

Returns

Type	Description
string

Save(XmlDocument, string)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string Save(XmlDocument xmlDoc, string filename)

Parameters

Type	Name	Description
XmlDocument	xmlDoc
string	filename

Returns

Type	Description
string

SetMaxUploadSize(IApplicationStatusInfo, long)

Declaration

public static void SetMaxUploadSize(IApplicationStatusInfo appStatus, long newSize)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
long	newSize

SetMaxUploadSize(long)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static void SetMaxUploadSize(long newSize)

Parameters

Type	Name	Description
long	newSize

Touch()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static bool Touch()

Returns

Type	Description
bool

Touch(IApplicationStatusInfo)

Declaration

public static bool Touch(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
bool

UpdateConnectionString(IApplicationStatusInfo, string)

Declaration

public static void UpdateConnectionString(IApplicationStatusInfo appStatus, string conn)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
string	conn

UpdateConnectionString(string)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static void UpdateConnectionString(string conn)

Parameters

Type	Name	Description
string	conn

UpdateDataProvider(IApplicationStatusInfo, string, string, string)

Declaration

public static void UpdateDataProvider(IApplicationStatusInfo appStatus, string name, string databaseOwner, string objectQualifier)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
string	name
string	databaseOwner
string	objectQualifier

UpdateDataProvider(string, string, string)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static void UpdateDataProvider(string name, string databaseOwner, string objectQualifier)

Parameters

Type	Name	Description
string	name
string	databaseOwner
string	objectQualifier

UpdateInstallVersion(IApplicationStatusInfo, Version)

Declaration

public static string UpdateInstallVersion(IApplicationStatusInfo appStatus, Version version)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
Version	version

Returns

Type	Description
string

UpdateInstallVersion(Version)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string UpdateInstallVersion(Version version)

Parameters

Type	Name	Description
Version	version

Returns

Type	Description
string

UpdateMachineKey()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string UpdateMachineKey()

Returns

Type	Description
string

UpdateMachineKey(IApplicationStatusInfo)

Declaration

public static string UpdateMachineKey(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
string

UpdateMachineKey(XmlDocument)

Declaration

public static XmlDocument UpdateMachineKey(XmlDocument xmlConfig)

Parameters

Type	Name	Description
XmlDocument	xmlConfig

Returns

Type	Description
XmlDocument

UpdateUpgradeConnectionString(IApplicationStatusInfo, string, string)

Declaration

public static void UpdateUpgradeConnectionString(IApplicationStatusInfo appStatus, string name, string upgradeConnectionString)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus
string	name
string	upgradeConnectionString

UpdateUpgradeConnectionString(string, string)

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static void UpdateUpgradeConnectionString(string name, string upgradeConnectionString)

Parameters

Type	Name	Description
string	name
string	upgradeConnectionString

UpdateValidationKey()

Declaration

[Obsolete("Deprecated in DotNetNuke 9.11.1. Use overload taking an IApplicationStatusInfo. Scheduled for removal in v11.0.0.")]
public static string UpdateValidationKey()

Returns

Type	Description
string

UpdateValidationKey(IApplicationStatusInfo)

Declaration

public static string UpdateValidationKey(IApplicationStatusInfo appStatus)

Parameters

Type	Name	Description
IApplicationStatusInfo	appStatus

Returns

Type	Description
string

UpdateValidationKey(XmlDocument)

Declaration

public static XmlDocument UpdateValidationKey(XmlDocument xmlConfig)

Parameters

Type	Name	Description
XmlDocument	xmlConfig

Returns

Type	Description
XmlDocument

Extension Methods

JsonExtensionsWeb.ToJson(object)