Class UserModuleBase

The UserModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal that manage Users.

Inheritance
System.Object
UserControlBase
PortalModuleBase
UserModuleBase
ProfileUserControlBase
UserUserControlBase
AuthenticationLoginBase
AuthenticationLogoffBase
Implements
Inherited Members
Namespace: DotNetNuke.Entities.Modules
Assembly: DotNetNuke.dll
Syntax
public class UserModuleBase : PortalModuleBase, IModuleControl

Properties

| Improve this Doc View Source

AddUser

Gets a value indicating whether we are in Add User mode.

Declaration
protected virtual bool AddUser { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsAdmin

Gets a value indicating whether the current user is an Administrator (or SuperUser).

Declaration
protected bool IsAdmin { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsEdit

Gets a value indicating whether the control is being called form the User Accounts module.

Declaration
protected bool IsEdit { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsHostTab

Gets a value indicating whether this control is in the Host menu.

Declaration
protected bool IsHostTab { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsProfile

Gets a value indicating whether the current user is modifying their profile.

Declaration
protected bool IsProfile { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsRegister

Gets a value indicating whether an anonymous user is trying to register.

Declaration
protected bool IsRegister { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsUser

Gets a value indicating whether the User is editing their own information.

Declaration
protected bool IsUser { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

IsUserOrAdmin

Gets a value indicating whether this is the current user or admin.

Declaration
protected bool IsUserOrAdmin { get; }
Property Value
Type Description
System.Boolean

gets whether this is the current user or admin.
| Improve this Doc View Source

User

Gets or sets the User associated with this control.

Declaration
public UserInfo User { get; set; }
Property Value
Type Description
UserInfo
| Improve this Doc View Source

UserId

Gets or sets the UserId associated with this control.

Declaration
public int UserId { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

UserPortalID

Gets the PortalId to use for this control.

Declaration
protected int UserPortalID { get; }
Property Value
Type Description
System.Int32

Methods

| Improve this Doc View Source

AddLocalizedModuleMessage(String, ModuleMessage.ModuleMessageType, Boolean)

AddLocalizedModuleMessage adds a localized module message.

Declaration
protected void AddLocalizedModuleMessage(string message, ModuleMessage.ModuleMessageType type, bool display)
Parameters
Type Name Description
System.String message

The localized message.
ModuleMessage.ModuleMessageType type

The type of message.
System.Boolean display

A flag that determines whether the message should be displayed.
| Improve this Doc View Source

AddModuleMessage(String, ModuleMessage.ModuleMessageType, Boolean)

AddModuleMessage adds a module message.

Declaration
protected void AddModuleMessage(string message, ModuleMessage.ModuleMessageType type, bool display)
Parameters
Type Name Description
System.String message

The message.
ModuleMessage.ModuleMessageType type

The type of message.
System.Boolean display

A flag that determines whether the message should be displayed.
| Improve this Doc View Source

CompleteUserCreation(UserCreateStatus, UserInfo, Boolean, Boolean)

The UserModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal that manage Users.

Declaration
protected string CompleteUserCreation(UserCreateStatus createStatus, UserInfo newUser, bool notify, bool register)
Parameters
Type Name Description
UserCreateStatus createStatus
UserInfo newUser
System.Boolean notify
System.Boolean register
Returns
Type Description
System.String
| Improve this Doc View Source

GetSetting(Int32, String)

Gets a Setting for the Module.

Declaration
public static object GetSetting(int portalId, string settingKey)
Parameters
Type Name Description
System.Int32 portalId
System.String settingKey
Returns
Type Description
System.Object

The setting value or null.
| Improve this Doc View Source

UpdateSetting(Int32, String, String)

The UserModuleBase class defines a custom base class inherited by all desktop portal modules within the Portal that manage Users.

Declaration
public static void UpdateSetting(int portalId, string key, string setting)
Parameters
Type Name Description
System.Int32 portalId
System.String key
System.String setting
| Improve this Doc View Source

UpdateSettings(Int32, Hashtable)

Updates the Settings for the Module.

Declaration
public static void UpdateSettings(int portalId, Hashtable settings)
Parameters
Type Name Description
System.Int32 portalId
Hashtable settings

Implements

Extension Methods