Table of Contents

Class ParagraphSettings

Namespace
Dynamicweb.Frontend.UserManagement
Assembly
Dynamicweb.dll

The Class ParagraphSettings represents settings based on paragraph properties

public sealed class ParagraphSettings
Inheritance
ParagraphSettings
Inherited Members

Constructors

ParagraphSettings(Properties)

Initialize a new ParagraphSettings based on given properties

public ParagraphSettings(Properties paragraphProperties)

Parameters

paragraphProperties Properties

The paragraph Properties

Properties

ApprovalRedirectPage

Gets the path to page used for redirecting user after approval

public string ApprovalRedirectPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

ConfirmationEmailAlwaysSend 

public bool ConfirmationEmailAlwaysSend { get; set; }

Property Value

bool

ConfirmationEmailFromAddress

Gets the sender address of confirmation e-mail

public string ConfirmationEmailFromAddress { get; }

Property Value

string

The Address

Remarks

used with show type

ConfirmationEmailFromName 

public string ConfirmationEmailFromName { get; }

Property Value

string

ConfirmationEmailSubject

Gets the subject of confirmation e-mail

public string ConfirmationEmailSubject { get; }

Property Value

string

The Subject

Remarks

used with show type

ConfirmationEmailTemplate

Gets the path to template used for confirmation e-mail

public string ConfirmationEmailTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

ConfirmationRedirectPage

Gets the path to page used for redirecting on user confirmation

public string ConfirmationRedirectPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

ConfirmationRedirectType

Gets the value indicating where to redirect on user confirmation

public RedirectType ConfirmationRedirectType { get; }

Property Value

RedirectType

Selected redirect type

Remarks

used with show type

CreateProfileApprovalType

Gets the value indicating how created profiles will be approved

public CreateProfileApprovalTypes CreateProfileApprovalType { get; }

Property Value

CreateProfileApprovalTypes

Selected approval type

Remarks

used with show type

CreateProfileEmailAllowedActivity 

public Activity CreateProfileEmailAllowedActivity { get; }

Property Value

Activity

CreateProfileNewUserGroups

Gets selected groups user will be placed into after profile creation

public ICollection<UserGroup> CreateProfileNewUserGroups { get; }

Property Value

ICollection<UserGroup>

The groups collection

Remarks

used with show type

CreateProfileRedirectPage

Gets the path to page used for redirecting user after create profile if redirect type is Page

public string CreateProfileRedirectPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

CreateProfileRedirectTemplate

Gets the path to template used for redirecting user after create profile if redirect type is template

public string CreateProfileRedirectTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

CreateProfileRedirectType

Gets the value indicating where to redirect user after creating profile

public RedirectType CreateProfileRedirectType { get; }

Property Value

RedirectType

Selected redirect type

Remarks

used with show type

CreateProfileSelectableGroups

Gets selected groups user allowed to join on profile creation

public ICollection<UserGroup> CreateProfileSelectableGroups { get; }

Property Value

ICollection<UserGroup>

The groups collection

Remarks

used with show type

CreateProfileTemplate

Gets the path to template used for creating user

public string CreateProfileTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

DeleteAddressMessage

Gets defined error message used for delete address

public string DeleteAddressMessage { get; }

Property Value

string

The message as String

DeleteDefaultAddressMessage

Gets defined error message used for delete default address

public string DeleteDefaultAddressMessage { get; }

Property Value

string

The message as String

DeleteMainAddressMessage

Gets defined error message used for delete main address

public string DeleteMainAddressMessage { get; }

Property Value

string

The message as String

DetailGroupTemplate

Gets the path to template used for displaying group details

public string DetailGroupTemplate { get; }

Property Value

string

The Path to group details template as String

Remarks

used with show type

DetailUserTemplate

Gets the path to template used for displaying user details

public string DetailUserTemplate { get; }

Property Value

string

The Path to user details template as String

Remarks

used with show type

DoUpdateUsersByEmail

Gets value indicating if users will be updated by its email

public bool DoUpdateUsersByEmail { get; }

Property Value

bool

Boolean value whether to update users

EditProfileEmailAllowedActivity 

public Activity EditProfileEmailAllowedActivity { get; }

Property Value

Activity

ErrorDuplicateEmail

Gets defined error message used for dublicate e-mail

public string ErrorDuplicateEmail { get; }

Property Value

string

The message as String

ErrorEmailNotFound

Gets defined error message used for e-mail is not found

public string ErrorEmailNotFound { get; }

Property Value

string

The message as String

ErrorEmptyEmail

Gets defined error message used for e-mail is empty

public string ErrorEmptyEmail { get; }

Property Value

string

The message as String

ErrorEmptyField

Gets defined error message used for empty field

public string ErrorEmptyField { get; }

Property Value

string

The message as String

ErrorEmptyPassword

Gets defined error message used for empty password

public string ErrorEmptyPassword { get; }

Property Value

string

The message as String

ErrorEmptyUsername

Gets defined error message used for empty user name

public string ErrorEmptyUsername { get; }

Property Value

string

The message as String

ErrorIllegalPasswordCharacters

Gets defined error message used for password contains illegal characters

public string ErrorIllegalPasswordCharacters { get; }

Property Value

string

The message as String

ErrorPasswordComplexity

Gets defined error message used for password complexity

public string ErrorPasswordComplexity { get; }

Property Value

string

The message as String

ErrorPasswordLength

Gets defined error message used for wrong password length

public string ErrorPasswordLength { get; }

Property Value

string

The message as String

ErrorPasswordReuse

Gets defined error message used for password reuse

public string ErrorPasswordReuse { get; }

Property Value

string

The message as String

ErrorPasswordSmallLength

Gets defined error message used for password too short

public string ErrorPasswordSmallLength { get; }

Property Value

string

The message as String

ErrorPasswordsNotMatch

Gets defined error message used for passwords doesn't match

public string ErrorPasswordsNotMatch { get; }

Property Value

string

The message as String

ErrorUsernameTaken

Gets defined error message used for user name is already taken

public string ErrorUsernameTaken { get; }

Property Value

string

The message as String

ErrorWrongCountryCode 

public string ErrorWrongCountryCode { get; }

Property Value

string

ErrorWrongPassword

Gets defined error message used for wrong password

public string ErrorWrongPassword { get; }

Property Value

string

The message as String

IncorrectEmailFormat

Gets defined error message used for e-mail has incorrect format

public string IncorrectEmailFormat { get; }

Property Value

string

The message as String

ListEditUserSelectableGroups

Gets selected groups are allowed for user to join while profile edit

public ICollection<UserGroup> ListEditUserSelectableGroups { get; }

Property Value

ICollection<UserGroup>

The groups collection

Remarks

used with show type

ListEditUserTemplate

Gets the path to list edit user template

public string ListEditUserTemplate { get; }

Property Value

string

The Path to list edit user template as String

Remarks

used with show type

ListGroups

Gets the groups collection selected in paragraph properties

public ICollection<UserGroup> ListGroups { get; }

Property Value

ICollection<UserGroup>

The groups collection

Remarks

used with show type

ListSubgroupSettings

Gets the settings related to handling subgroups

public SubgroupSettingsInfo ListSubgroupSettings { get; }

Property Value

SubgroupSettingsInfo

The settings

Remarks

used with show type

ListTemplate

Gets the path to template used for displaying list of user and/or groups

public string ListTemplate { get; }

Property Value

string

The Path to selected list template as String

Remarks

used with show type

ListUserSortField

Gets the sorting field

public SortField ListUserSortField { get; }

Property Value

SortField

Selected sort field

Remarks

used with show type

ListUserSortOrder

Gets the sorting order

public SortOrder ListUserSortOrder { get; }

Property Value

SortOrder

Selected sort order

Remarks

used with show type

ListUsers

Gets the complete users collection selected in paragraph properties

public ICollection<User> ListUsers { get; }

Property Value

ICollection<User>

The users collection

Remarks

used with show type

LoggedInRedirectPage

Gets the path to page used for redirecting user after log in

public string LoggedInRedirectPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

LoginSuccessRedirectToPage

Gets the path to page used for redirecting user after log in

public string LoginSuccessRedirectToPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

LoginTemplate

Gets the path to template used for login user

public string LoginTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

MatchAnonymousOrdersOnEmail

Gets value indicating if anonymous orders will be associated with new user by its email

public bool MatchAnonymousOrdersOnEmail { get; }

Property Value

bool

Boolean value whether to associate orders with user

NotificationEmailFromAddress

Gets the sender address of notification e-mail

public string NotificationEmailFromAddress { get; }

Property Value

string

The Address

Remarks

used with show type

NotificationEmailFromName

Gets the sender name of notification e-mail

public string NotificationEmailFromName { get; }

Property Value

string

The Name

Remarks

used with show type

NotificationEmailRecipients

Gets the recipients collection selected in paragraph properties for e-mail notifications

public ICollection<User> NotificationEmailRecipients { get; }

Property Value

ICollection<User>

The users collection

Remarks

used with show type

NotificationEmailSubject

Gets the subject of notification e-mail

public string NotificationEmailSubject { get; }

Property Value

string

The Subject

Remarks

used with show type

NotificationEmailTemplate

Gets the path to template used for notification e-mails

public string NotificationEmailTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

NotificationRedirectPage

Gets the path to page used for redirecting on admin notification

public string NotificationRedirectPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

NotificationRedirectType

Gets the value indicating where to redirect on admin notification

public RedirectType NotificationRedirectType { get; }

Property Value

RedirectType

Selected redirect type

Remarks

used with show type

PagingHandler

Gets the handler of paging results

public PagingHandler PagingHandler { get; }

Property Value

PagingHandler

The handler

Remarks

used with show type

PasswordRecoveryEmailFrom

Gets the sender address of password recovery e-mail

public string PasswordRecoveryEmailFrom { get; }

Property Value

string

The Address

Remarks

used with show type

PasswordRecoveryEmailRedirectPage

Gets the path to page used for redirecting on password recovery

public string PasswordRecoveryEmailRedirectPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

PasswordRecoveryEmailSubject

Gets the subject of password recovery e-mail

public string PasswordRecoveryEmailSubject { get; }

Property Value

string

The Subject

Remarks

used with show type

PasswordRecoveryEmailTemplate

Gets the path to template used for password recovery e-mail

public string PasswordRecoveryEmailTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

PasswordRecoveryLinkLifeTime

Gets defined hours amount if password recovery method is SendRestoreLink

public int PasswordRecoveryLinkLifeTime { get; }

Property Value

int

The hours amount as Integer

Remarks

used with show type

PasswordRecoveryMethod

Gets the password recovery method

public PasswordRecoveryMethod PasswordRecoveryMethod { get; }

Property Value

PasswordRecoveryMethod

Selected password recovery method

Remarks

used with show type

PasswordRecoveryOperator

Gets operator indicating whether all of field should be equal or at least any of them

public string PasswordRecoveryOperator { get; }

Property Value

string

String value "RecoveryOperatorAND" if "All selected fields must apply" is selected in paragraph settings or "AnyField" if "Any selected fields must apply" is selected in paragraph settings

Remarks

used with show type

PasswordRecoveryRedirectType

Gets the value indicating where to redirect on password recovery

public RedirectType PasswordRecoveryRedirectType { get; }

Property Value

RedirectType

Selected redirect type

Remarks

used with show type

PasswordRecoveryTemplate

Gets the path to template used for password recovery

public string PasswordRecoveryTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

PasswordRecoveryUserFields

Gets the fields selected for using with password recovery

public string[] PasswordRecoveryUserFields { get; }

Property Value

string[]

Selected password recovery fields String array

Remarks

used with show type

PasswordResetTemplate

Gets the path to template used for password reset

public string PasswordResetTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

RequireUniqueEmails 

public bool RequireUniqueEmails { get; }

Property Value

bool

SearchResultTemplate

Gets the path to template used for displaying search result

public string SearchResultTemplate { get; }

Property Value

string

The Path to search result template as String

Remarks

used with show type

SearchTemplate

Gets the path to template used for searching

public string SearchTemplate { get; }

Property Value

string

The Path to search result template as String

Remarks

used with show type

SetProfile

Gets value indicating if user profile should be created

public bool SetProfile { get; }

Property Value

bool

Boolean value whether user profile should be created

ShowProfileAddAddressTemplate

Gets the path to template used for displaying user address with allowed adding address

public string ShowProfileAddAddressTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

ShowProfileAllowEdit

Gets value indicating if profile edit will be allowed in show profile

public bool ShowProfileAllowEdit { get; }

Property Value

bool

Boolean value whether to allow edit profile

Remarks

used with show type if Show profile setting set to show logged in user

ShowProfileEditAddressesTemplate

Gets the path to template used for editing user address

public string ShowProfileEditAddressesTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

ShowProfileEditUserSelectableGroups

Gets selected groups are allowed for user to join on show profile

public ICollection<UserGroup> ShowProfileEditUserSelectableGroups { get; }

Property Value

ICollection<UserGroup>

The groups collection

Remarks

used with show type

ShowProfileEditUserTemplate

Gets the path to template used for displaying user profile in edit profile

public string ShowProfileEditUserTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

ShowProfileTemplate

Gets the path to template used for showing user profile

public string ShowProfileTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

ShowProfileUser

Gets selected mode selected for showing user profile

public ShowProfileUserMode ShowProfileUser { get; }

Property Value

ShowProfileUserMode

Mode selected for showing user profile

Remarks

used with show type

ShowProfileUserID

Gets value indicating if profile user id will be shown

public int ShowProfileUserID { get; }

Property Value

int

Boolean value whether to show profile user id

ShowProfileViewAddressesTemplate

Gets the path to template used for displaying user address

public string ShowProfileViewAddressesTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

ShowType

Gets selected type for showing user profile

public ShowType ShowType { get; }

Property Value

ShowType

Type selected for showing user profile

UploadedImagesFolder

Gets the path to upload folder for images

public string UploadedImagesFolder { get; }

Property Value

string

Returns path to folder as String

UploadedImagesMaxHeight

Gets the max height of upload images

public int UploadedImagesMaxHeight { get; }

Property Value

int

Returns max height if defined in paragraph properties otherwise returns 0 as Integer

UploadedImagesMaxWidth

Gets the max width of upload images

public int UploadedImagesMaxWidth { get; }

Property Value

int

Returns max width if defined in paragraph properties otherwise returns 0 as Integer

UseEmailForUserName 

public bool UseEmailForUserName { get; }

Property Value

bool

UserNotificationEmailFromAddress

Gets the sender address of notification e-mail to created user

public string UserNotificationEmailFromAddress { get; }

Property Value

string

The Address

Remarks

used with show type

UserNotificationEmailFromName

Gets the sender name of notification e-mail to created user

public string UserNotificationEmailFromName { get; }

Property Value

string

The Name

Remarks

used with show type

UserNotificationEmailSubject

Gets the subject of notification e-mail to created user

public string UserNotificationEmailSubject { get; }

Property Value

string

The Subject

Remarks

used with show type

UserNotificationEmailTemplate

Gets the path to template used for notification e-mails to created user

public string UserNotificationEmailTemplate { get; }

Property Value

string

The Path to the template as String

Remarks

used with show type

UserNotificationRedirectPage

Gets the path to page used for redirecting on user notification

public string UserNotificationRedirectPage { get; }

Property Value

string

The Path to the page as String

Remarks

used with show type

UserNotificationRedirectType

Gets the value indicating where to redirect on user notification

public RedirectType UserNotificationRedirectType { get; }

Property Value

RedirectType

Selected redirect type

Remarks

used with show type

Improve this doc
To top