Click or drag to resize
ForumViewer Class
Summary description for ForumViewer.
Inheritance Hierarchy

Namespace: CMS.Forums.Web.UI
Assembly: CMS.Forums.Web.UI (in CMS.Forums.Web.UI.dll) Version: 12.0.0
Syntax
C#
public class ForumViewer : CMSUserControl, 
	IPostBackEventHandler

The ForumViewer type exposes the following members.

Constructors
  NameDescription
Public methodForumViewer
Constructor.
Top
Properties
  NameDescription
Public propertyAbuseReportAccess
Gets or sets the security access enum to abuse report (Authenticated users by default).
Public propertyAbuseReportRoles
Gets or sets the roles split by semicolon, which roles can report abuse, requires security access state authorize roles.
Public propertyAccessDeniedPageURL
Gets or sets the access denied page URL (URL where the user is redirected when trying to access forum for which the user is unauthorized).
Public propertyAttachmentImageMaxSideSize
Gets or sets the maximum side size of image shown in post attachment list.
Public propertyAvatarMaxSideSize
Gets or sets the max side size of avatar image.
Public propertyBaseURL
Gets or sets the forum base URL.
Public propertyCommunityGroupID
Gets or sets the community group id.
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDisplayAttachmentImage
Gets or sets the value that indicates whether image attachment should be displayed like an image.
Public propertyDisplayBadgeInfo
Gets or sets the value that indicates whether badge info should be displayed.
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyEnableAvatars
Gets or sets the value that indicates whether avatars should be displayed.
Public propertyEnableFavorites
Indicates whether user can add the posts to his favorites.
Public propertyEnableOnSiteManagement
Gets or sets the value that indicates whether onsite management is allowed.
Public propertyEnablePostsPaging
Gets or sets the value that indicates whether paging should be used on posts list page.
Public propertyEnableSignature
Indicates whether user signature should be displayed.
Public propertyEnableSubscription
Gets or sets the value that indicates whether subscription is enabled.
Public propertyEnableThreadPaging
Gets or sets the value that indicates whether paging should be used on thread list page.
Public propertyExpandTree
Gets or sets the value that indicates whether forum with tree layout should be expanded.
Public propertyForumID
Gets or sets the forum id base on current url or settings.
Public propertyForumLayout
Gets or sets the forum layout.
Public propertyForumViewMode
Gets or sets the thread view mode.
Public propertyFriendlyBaseURL
Gets or sets base URL for forum which use friendly URLs, if URL is not set URL is set from current document.
Public propertyFriendlyURLExtension
Gets or sets the friendly URL extension.
Public propertyGenerateActionScripts
Gets or sets the value that indicates whether action scripts should be generated.
Public propertyGroupID
Gets or sets the group id based on current settings.
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyHideForumForUnauthorized
Gets or sets the value that indicates whether the forums for which the user has no permissions are visible in the list of forums in forum group.
Public propertyIsAdHocForum
Gets or sets the value that indicates whether current forum is AdHoc.
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyLogActivity
Gets or sets value that indicates whether logging activity is performed.
Public propertyLogonPageURL
Gets or sets the logon page URL.
Public propertyMaxRelativeLevel
Gets or sets the maximal nesting level of posts.
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyParameter
Control parameter.
(Inherited from InlineUserControl.)
Public propertyPostsPageSize
Gets or sets the size of posts page size.
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyRedirectToUserProfile
Gets or sets the value that indicates whether username is link to user profile. User profile path must be defined in site settings
Public propertyRedirectUnauthorized
Gets or sets the value that indicates whether use should be redirected to logon page if he hasn't appropriate permissions to the requested action.
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertySearchInForums
Gets or sets the forums in which should be search performed.
Public propertySearchInGroups
Gets or sets the groups names in which should be search proceeded, use semicolon like separator.
Public propertySearchInThreads
Gets or sets the threads where search should be performed.
Public propertySearchNoResults
Gets or sets the text which should be displayed if no result found.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyShowMode
Gets or sets the tree forum show mode.
Public propertySiteID
Gets or sets the site id which should be used for current control.
Public propertySiteName
Gets or sets the site name which should be used for current control.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyThreadID
Gets or sets the thread id based on current url or settings.
Public propertyThreadOrderBy
Gets order by expression with dependence on current view mode.
Public propertyThreadPageSize
Gets or sets the size of thread list page.
Public propertyUIContext
Control's UI Context
(Inherited from CMSUserControl.)
Public propertyUnsubscriptionURL
Gets or sets the unsubscription URL.
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUseFriendlyURL
Gets or sets the value that indicates whether forums should generate friendly URLs.
Public propertyUseRedirectAfterAction
Gets or sets the value that indicates whether after action should be used redirect.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Public propertyViewMode
Gets or sets the thread view mode.
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWhereCondition
Gets or sets the where condition.
Top
Methods
  NameDescription
Public methodAddConfirmation
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddError
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddHeaderAction
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.)
Public methodAddInformation
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddMessage
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAddWarning
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.)
Public methodAdministratorCode(Object, String)
Returns html code if current user is moderator.
Public methodAdministratorCode(Object, String, Boolean)
Returns html code if current user is moderator.
Public methodAvatarImage
Returns avatar image.
Public methodClearURL
Returns url without action parameters.
Public methodCopyValues
Copy current properties to the child control.
Public methodStatic memberCopyValuesFromParent
Tries to find parent forum viewer and copy values.
Public methodEnsureControls
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.)
Public methodEval(String)
Evaluates the given value
(Inherited from AbstractUserControl.)
Public methodEval(String, Boolean)
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.)
Public methodEvalBool
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.)
Public methodEvalDateTime
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.)
Public methodEvalDecimal
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.)
Public methodEvalDouble
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.)
Public methodEvalGuid
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.)
Public methodEvalHTML
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.)
Public methodEvalHtmlAttribute
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.)
Public methodEvalInteger
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.)
Public methodEvalJSString
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.)
Public methodEvalText(String)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodEvalText(String, Boolean)
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.)
Public methodGenerateAnswerCode
Generate code if current post is mark as answer.
Public methodGenerateIndentCode
Generate indent code.
Protected methodGetAccessDeniedPageUrl
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.)
Public methodGetData
Returns data from datarow or datarowview and specified column.
Public methodGetFlagIconUrl
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.)
Public methodGetImageClass
Retruns css class.
Public methodGetImagePath
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetImageUrl
Gets UI image relative path.
(Inherited from AbstractUserControl.)
Public methodGetLink
Returns link with dependence on parameters.
Public methodGetNotEmpty
Return text with dependence on input value, if value is null or empty returns not empty text parameter otherwise returns empy text parameter
Public methodGetSearchDataSet
Retusrn search dataset.
Public methodGetSignatureArea
Returnes Signature area if signature is enabled and is not empty.
Public methodGetString
Returns the localized string of the control's hierarchically highest parent that has the ResourcePrefix property and its translation defined.
(Inherited from AbstractUserControl.)
Public methodGetURL
Returns action URL.
Public methodGetUserName
Generate HTML part with username, if forum is set to display email then generates mailto: If username should be link to user profile generates link to user profile
Public methodGetValue(String)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodGetValueReturnType(String, ReturnType)
Returns the value of the given property.
(Inherited from InlineUserControl.)
Public methodHasValue
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.)
Public methodStatic memberIFCompare
Returns true or false rusult with dependence on bool condition.
Public methodIsAvailable
Returns true if action is available.
Public methodLastTime
Returns string representation of datetime of last post for current forum or thread.
Public methodLastUser
Returns user name of last post for current forum or thread.
Public methodLoadUserControl
Loads the user control based on the given path
(Inherited from AbstractUserControl.)
Public methodLogAndShowError
Logs the exception and
(Inherited from AbstractUserControl.)
Public methodOnContentLoaded
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.)
Protected methodOnInit
Init event handler.
(Inherited from AbstractUserControl.)
Protected methodOnLoad
Load event handler.
(Inherited from AbstractUserControl.)
Protected methodOnPreRender
PreRender event handler.
(Inherited from AbstractUserControl.)
Public methodPostCount
Returns number of posts in current forum or thread.
Public methodRaisePostBackEvent
Ensures post back event.
Public methodRedirectToAccessDenied(String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(Int32, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToAccessDenied(String, String)
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Protected methodRedirectToUIElementAccessDenied
Redirects the user to Access denied page.
(Inherited from CMSUserControl.)
Public methodReleaseContext
Releases the control context.
(Inherited from CMSUserControl.)
Public methodReloadData
Reloads the data of the forum control.
Protected methodRender
Render event handler.
(Inherited from AbstractUserControl.)
Public methodRepliesCount
Returns number of replies for current thread.
Public methodResolvePostText(Object)
Resolve post text with dependence on current forum and ensures line endings of the post text.
Public methodResolvePostText(Object, Object)
Resolve post text with dependence on current forum.
Public methodResolveUrl
Resolves the given URL
(Inherited from AbstractUserControl.)
Public methodSetContext
Sets the control context.
(Inherited from CMSUserControl.)
Public methodSetValue
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.)
Public methodShowChangesSaved
Shows the general changes saved message.
(Inherited from AbstractUserControl.)
Public methodShowConfirmation
Shows the general confirmation message.
(Inherited from AbstractUserControl.)
Public methodShowError
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowInformation
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowMessage(MessageTypeEnum, String, String, String, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Protected methodShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodShowWarning
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.)
Public methodThreadCount
Returns number of threads in current forum.
Protected methodTrackViewState
Tracks the view state.
(Inherited from InlineUserControl.)
Public methodUnaprovedPosts
Returns string with information about unapproved posts.
Public methodURLCreator(String, String, Boolean, Object, Boolean)
Returns url with dependence on parameters.
Public methodURLCreator(String, String, Boolean, Object, ForumActionType, Boolean)
Returns url with dependence on parameters.
Top
Extension Methods
  NameDescription
Public Extension MethodCallHandled
Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false.
(Defined by ControlsExtensions.)
Public Extension MethodGetString
Gets the string by the specified resource key
(Defined by ControlsExtensions.)
Top
See Also