ForumContext Class

Forum context.

Inheritance Hierarchy

System.Object
  CMS.Base.AbstractSimpleDataContainer<ForumContext>
    CMS.Base.AbstractDataContainer<ForumContext>
      CMS.Base.AbstractHierarchicalObject<ForumContext>
        CMS.Base.ContextContainer<ForumContext>
          CMS.Base.AbstractContext<ForumContext>
            CMS.Forums.ForumContext

Namespace: CMS.Forums
Assembly: CMS.Forums (in CMS.Forums.dll) Version: 8.2.23

Syntax

public class ForumContext : AbstractContext<ForumContext>

The ForumContext type exposes the following members.

Constructors

	Name	Description
Public method	ForumContext

Methods

	Name	Description
Public method	ClearCurrent	Clears the current context value (Inherited from ContextContainer<TParent>.)
Public method	CloneForNewThread	Clones the object for new thread (Inherited from AbstractContext<TContext>.)
Public method	CombineWith	Combines current instance with other properties (modifies current instace!). List properties are merged from all the participating typeinfos, other properties are taken as first non-null value (non-null is determined by nullValues collection). (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	ContainsColumn	Returns true if specified column is available in current structure. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public method Static member	DisplayOnlyMe	Hide all forum viewers except the sender.
Public method	GetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	GetPropertyType	Gets the type of the given property (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	GetValue	Gets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	HasSetter	Returns true if given property has a setter (Inherited from AbstractHierarchicalObject<TObject>.)
Public method Static member	CheckSite	Checks if current post, forum or group is belong to current site. You have to insert at least one ID other parameters could be zero.
Public method Static member	IsCommunityGroupAdmin(Int32)	Returns true if current user is group admin for selected forum.
Public method Static member	IsCommunityGroupAdmin(Int32, UserInfo)	Returns true if specified user is group admin for selected forum.
Protected method	RegisterColumn(String, Func<TObject, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumn(String, Func<TObject, Object>, Func<TObject, Object, Object>)	Registers the given Column to the object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterColumns	Registers the Columns of this object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected method	RegisterProperties	Registers the properties of this object (Overrides AbstractHierarchicalObject<TObject>.RegisterProperties().)
Protected method	RegisterProperty(String, Func<TObject, Object>)	Registers the given property to the object (Inherited from AbstractHierarchicalObject<TObject>.)
Protected method	RegisterProperty(String, Object, Func<TObject, Object, Object>)	Registers the given parameterized property to the object. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetAsCurrent	Sets the current instance as the current thread item (Inherited from ContextContainer<TParent>.)
Public method	SetProperty	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	SetValue	Sets the object value. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method	TryGetProperty(String, Object)	Gets the context property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetProperty(String, Object, Boolean)	Returns value of property. (Inherited from AbstractHierarchicalObject<TObject>.)
Public method	TryGetValue	Returns value of column. (Inherited from AbstractSimpleDataContainer<TObject>.)
Public method Static member	UserIsModerator(Int32, Int32)	Returns true if current user is moderator of current forum.
Public method Static member	UserIsModerator(Int32, Int32, UserInfo)	Returns true if specified user is moderator of current forum.

Extension Methods

	Name	Description
Public Extension Method	AsValue	Converts object to a query value which can be used as a query parameter (Defined by QueryExtensions.)
Public Extension Method	GetAPIString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by CoreExtensions.)
Public Extension Method	ToBoolean	Returns the boolean representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDateTime	Returns the DateTime representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToDouble	Returns the double representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToGuid	Returns the Guid representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToInteger	Returns the integer representation of an object or default value if not. (Defined by CoreExtensions.)
Public Extension Method	ToString	Returns the string representation of an object or default value if not. (Defined by CoreExtensions.)

Properties

	Name	Description
Public property	ColumnNames	Available column names. (Inherited from AbstractDataContainer<ParentObjectType>.)
Public property Static member	CommunityGroupID	Gets or sets community group id.
Public property Static member	CurrentForum	Returns current forum.
Public property Static member	CurrentForumDiscussionMacroHelper	Gets Discussion macro helper for current forum.
Public property Static member	CurrentGroup	Returns current thread.
Public property Static member	CurrentMode	Gets current forum mode.
Public property Static member	CurrentPost	Returns current post for edit or attachment.
Public property Static member	CurrentReplyThread	Returns curren reply thread info.
Public property Static member	CurrentState	Gets the current forum mode.
Public property Static member	CurrentSubscribeThread	Returns curren reply thread info.
Public property Static member	CurrentThread	Returns current thread.
Public property Static member	ForumID	Gets or sets the forum id base on current url or settings.
Public property Static member	ForumViewers	Collection of forum viewers.
Public property Static member	GroupID	Gets or sets the group id based on current settings.
Public property	IsDefault	Returns true if the context is the default request context (Inherited from ContextContainer<TParent>.)
Public property	Item	Gets the value of particular property (Inherited from AbstractHierarchicalObject<TObject>.)
Public property	Key	Unique container key (Inherited from ContextContainer<TParent>.)
Public property	Properties	Properties available through the context. (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	PropertyList	Used property list (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredColumns	Registered Columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredColumnsObject	Registered Columns object (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	RegisteredProperties	Registered properties (Inherited from AbstractHierarchicalObject<TObject>.)
Protected property	RegisteredPropertiesObject	Registered properties object (Inherited from AbstractHierarchicalObject<TObject>.)
Public property Static member	ReplyThreadID	Gets or sets the forum id base on current url or settings.
Public property Static member	SiteID	Gets or sets the site ID.
Public property Static member	StopViewerLoading	Gets or sets tha value that indicates whether forum viewers shouldn't be loaded.
Public property Static member	SubscribeThreadID	Gets or sets the forum id base on current url or settings.
Public property Static member	ThreadID	Gets or sets the thread id based on current url or settings.
Protected property	UseLocalColumns	If true, the object uses local columns (Inherited from AbstractSimpleDataContainer<TObject>.)
Protected property	UseLocalProperties	If true, the object uses local properties (Inherited from AbstractHierarchicalObject<TObject>.)
Public property Static member	UserIsModeratorInSomeForum	Returns true if current user is moderator in at least one forum.