Class Renderer

Namespace

Dynamicweb.Frontend.UserManagement

Assembly

Dynamicweb.dll

The Class Renderer represents renderer user management related entities

public sealed class Renderer

Inheritance

object

Renderer

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Methods

RenderGroup(UserGroup, Template, PagingHandler)

Renders the group

public static void RenderGroup(UserGroup group, Template template, PagingHandler pagingHandler)

Parameters

group UserGroup

Group to be rendered

template Template

Template to render group into.

pagingHandler PagingHandler

Paging handler used to split results to pages

Remarks

Contained users and subgroups will not be rendered and results will be sorted by name in ascending direction

RenderGroup(UserGroup, Template, bool, SortField, SortOrder, PagingHandler)

Renders the group

public static void RenderGroup(UserGroup group, Template template, bool includeGroupsAndUsers, SortField userSortField, SortOrder userSortOrder, PagingHandler pagingHandler)

Parameters

group UserGroup

Group to be rendered

template Template

Template to render group into.

includeGroupsAndUsers bool

Indicates whether to render сontained users and subgroups

userSortField SortField

User Field that used for ordering

userSortOrder SortOrder

Direction used for ordering

pagingHandler PagingHandler

Paging handler used to split results to pages

RenderGroupTemplateExtenders(UserGroup, Template, bool, string, SortField, SortOrder, PagingHandler)

Extends a User template with TemplateExtenders

public static void RenderGroupTemplateExtenders(UserGroup group, Template template, bool includeGroupsAndUsers, string elementName, SortField userSortField, SortOrder userSortOrder, PagingHandler pagingHandler)

Parameters

group UserGroup

The currently rendered group

template Template

The template rendering the user

includeGroupsAndUsers bool

Flag - include groups and users

elementName string

Element name

userSortField SortField

Users sort field

userSortOrder SortOrder

Users sort order

pagingHandler PagingHandler

Paging handler

RenderGroups(IEnumerable<UserGroup>, Template, PagingHandler)

Renders the groups

public static void RenderGroups(IEnumerable<UserGroup> groups, Template template, PagingHandler pagingHandler)

Parameters

groups IEnumerable<UserGroup>

collection of groups to be rendered

template Template

Template to render users into.

pagingHandler PagingHandler

Paging handler used to split results to pages

Remarks

Contained users and subgroups will not be rendered and results will be sorted by name in ascending direction

RenderGroups(IEnumerable<UserGroup>, Template, bool, SortField, SortOrder, PagingHandler)

Renders the groups

public static void RenderGroups(IEnumerable<UserGroup> groups, Template template, bool includeGroupsAndUsers, SortField userSortField, SortOrder userSortOrder, PagingHandler pagingHandler)

Parameters

groups IEnumerable<UserGroup>

collection of groups to be rendered

template Template

Template to render users into.

includeGroupsAndUsers bool

Indicates whether to render сontained users and subgroups

userSortField SortField

User Field that used for ordering

userSortOrder SortOrder

Direction used for ordering

pagingHandler PagingHandler

Paging handler used to split results to pages

Remarks

Groups will be rendered inside loop named "Groups"

RenderSearchForm(Template)

Renders the search form.

public static void RenderSearchForm(Template searchBoxTemplate)

Parameters

searchBoxTemplate Template

Template containing search box markup.

RenderSearchForm(Template, Template, int)

Renders the search form.

public static void RenderSearchForm(Template searchBoxTemplate, Template masterTemplate, int paragraphID)

Parameters

searchBoxTemplate Template

Template containing search form markup.

masterTemplate Template

Template to render search form contents into.

paragraphID int

An ID of the module paragraph.

RenderUser(User, Template, bool, PagingHandler)

Renders the user

public static void RenderUser(User user, Template template, bool includeParentGroups, PagingHandler pagingHandler)

Parameters

user User

User to be rendered

template Template

Template to render user into.

includeParentGroups bool

Indicates whether to render parent groups

pagingHandler PagingHandler

Paging handler used to split results to pages

Remarks

Tags for user editing will be rendered also

RenderUser(User, Template, bool, PagingHandler, bool)

Renders the user

public static void RenderUser(User user, Template template, bool includeParentGroups, PagingHandler pagingHandler, bool allowEdit)

Parameters

user User

User to be rendered

template Template

Template to render user into.

includeParentGroups bool

Indicates whether to render parent groups

pagingHandler PagingHandler

Paging handler used to split results to pages

allowEdit bool

Indicates whether to render tags for user editing

RenderUserAddress(UserAddress, Template)

Renders the address related tags

public static void RenderUserAddress(UserAddress address, Template template)

Parameters

address UserAddress

Address to be rendered

template Template

Template to render the address tags into.

RenderUserAddressAdd(int, bool, int, Template, List<UserManagementFormField>)

Renders the user add/update address related tags

public static void RenderUserAddressAdd(int userID, bool forUpdate, int addressId, Template template, List<UserManagementFormField> errors)

Parameters

userID int

ID of User address will be added/Updated

forUpdate bool

Indicates is adding new address or update existing

addressId int

ID of address object

template Template

Template to render user address tags into.

errors List<UserManagementFormField>

List of errors

RenderUserAddresses(User, Template, ParagraphSettings)

Renders the all of the user addresses

public static void RenderUserAddresses(User user, Template template, ParagraphSettings settings)

Parameters

user User

User who's addresses will be rendered

template Template

Template to render the address tags into.

settings ParagraphSettings

Settings of the related paragraph

RenderUserCreate(IEnumerable<UserGroup>, IEnumerable<UserGroup>, CreateProfileApprovalTypes, IDictionary<string, UserManagementFormField>, Template, PagingHandler)

Renders the user edit related tags

public static void RenderUserCreate(IEnumerable<UserGroup> NewUserGroups, IEnumerable<UserGroup> SelectableGroups, CreateProfileApprovalTypes ApprovalType, IDictionary<string, UserManagementFormField> errors, Template template, PagingHandler pagingHandler)

Parameters

NewUserGroups IEnumerable<UserGroup>

Groups where newly created user will be added

SelectableGroups IEnumerable<UserGroup>

Groups which are allowed for user to join in

ApprovalType CreateProfileApprovalTypes

errors IDictionary<string, UserManagementFormField>

Collection used for handling errors

template Template

Template to render user into.

pagingHandler PagingHandler

Paging handler used to split results to pages

RenderUserEdit(User, IEnumerable<UserGroup>, IDictionary<string, UserManagementFormField>, Template, PagingHandler)

Renders the user edit related tags

public static void RenderUserEdit(User user, IEnumerable<UserGroup> selectableGroups, IDictionary<string, UserManagementFormField> errors, Template template, PagingHandler pagingHandler)

Parameters

user User

User to be rendered

selectableGroups IEnumerable<UserGroup>

Groups which are allowed for user to join in

errors IDictionary<string, UserManagementFormField>

Collection used for handling errors

template Template

Template to render user into.

pagingHandler PagingHandler

Paging handler used to split results to pages

RenderUserNameInputs(IDictionary<string, UserManagementFormField>, Template, string)

Renders the user name input controls related tags

public static void RenderUserNameInputs(IDictionary<string, UserManagementFormField> errors, Template template, string userName = "")

Parameters

errors IDictionary<string, UserManagementFormField>

Collection used for handling errors

template Template

Template to render inputs related tags into.

userName string

User name as default value for input control

RenderUserTemplateExtenders(UserAction, User, Template, bool, PagingHandler)

Extends a User template with TemplateExtenders

public static void RenderUserTemplateExtenders(UserAction action, User user, Template template, bool includeParentGroups, PagingHandler pagingHandler)

Parameters

action UserAction

The current action

user User

The currently rendered user

template Template

The template rendering the user

includeParentGroups bool

Flag - include parent groups

pagingHandler PagingHandler

Paging handler

RenderUsers(IEnumerable<User>, Template, SortField, SortOrder, bool, PagingHandler, UserGroup)

Renders the users

public static void RenderUsers(IEnumerable<User> users, Template template, SortField sortField, SortOrder sortOrder, bool includeParentGroups, PagingHandler pagingHandler, UserGroup sortInGroup)

Parameters

users IEnumerable<User>

collection of users to be rendered

template Template

Template to render users into.

sortField SortField

User Field that used for ordering

sortOrder SortOrder

Direction used for ordering

includeParentGroups bool

Indicates whether to render parent groups

pagingHandler PagingHandler

Paging handler used to split results to pages

sortInGroup UserGroup

The Group in which users will be sorted

Remarks

Users will be rendered inside loop named "Users"

RenderUsersAndGroups(IEnumerable<User>, IEnumerable<UserGroup>, int, SortField, SortOrder, Template, PagingHandler)

Renders the users and groups

public static void RenderUsersAndGroups(IEnumerable<User> users, IEnumerable<UserGroup> groups, int numSubgroupLevels, SortField userSortField, SortOrder userSortOrder, Template template, PagingHandler pagingHandler)

Parameters

users IEnumerable<User>

collection of users to be rendered

groups IEnumerable<UserGroup>

collection of groups to be rendered

numSubgroupLevels int

The number of subgroups that should be included into rendering

userSortField SortField

User Field that used for ordering

userSortOrder SortOrder

Direction used for ordering

template Template

Template to render users and groups into.

pagingHandler PagingHandler

Paging handler used to split results to pages