MessageBoard Server Control

MessageBoard Server Control Properties

The following are Ektron-specific server control properties. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that the server control’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• CommentBoxLocation

  Defines the location of the comment box. By default, bottom is selected. Choices are:

  • Bottom—comment box appears below the comments
  • Top—comment box appears above the comments
  • Data Type: EkEnumeration.MessageBoardCommentBoxLocation
• DefaultObjectID (Long)

  The default object ID for this control to use when there is no matching dynamic parameter value passed.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• DoInitFill (Boolean)

  By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, Fill is automatically called during the Page Render event. You might do this if you need to set or change a property on the control in code-behind and have it render with your changes shown.

• DynamicObjectParameter (String)

  Gets or sets the QueryString parameter to read a object ID dynamically. To use the default object ID, leave blank.

• EnablePaging (Boolean)

  This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of items while controlling the amount of screen space. The MaxNumber property limits the number of items displayed. If you set this property to True, and the number of items exceeds MaxNumber, navigation aids appear below the last item, allowing the visitor to go to the next screen.

• Hide (Boolean)

  Hides or displays the output of the control in design time and run time.

  • True—Hide the control output.
  • False—Display the control output.
• Language (Integer)

  Set a language for viewing content; shows results in design-time (in Visual Studio) and at run-time (in a browser).

• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkML file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Output with Ektron Markup LanguageControlling Output with Ektron Markup Language

• MaxResults (Integer)

  Enter the maximum number of items to appear in the initial display of this server control. To set no maximum, enter zero (0). To let site visitors view more than the maximum but limit the amount of space, enter the maximum number of results per page here. Then, set the EnablePaging property to True. If you do and more than the number of MaxResults are available, navigation aids help the site visitor view additional items.

• Moderate (Boolean)

  Set to True to force moderation of the Message Board. If set to false, moderation is controlled by the user or community group with which the Message Board is associated. See Also: Moderating a Message Board

• ObjectType (EkEnumeration.MessageBoardObjectType)

  The type of object to which the Message Board is assigned. Choices are:

  • Content—a content item
  • User—an individual
  • CommunityGroup—a community group
• ProfileParamName (String)

  The parameter name to pass in the QueryString to the TemplateUserProfile page, if you want it to be anything other than id. For example, you may prefer userid, because it is more descriptive, as shown in the following example.

  

• ShowMaxCharacter (Integer)

  The maximum number of characters to display in the comment. If the number of characters in a comment exceeds this, a ... more >> link appears. Users click the link to see the full text.

• SpamControlType (EkEnumeration.MessageBoardSpamControlType)

  Assigns a spam filter to the Message Board. Ektron provides 3 spam filters, and the ability to define your own. Spam control is turned off by default. Filter choices are:

  • SameUserMessageDay—a user cannot post the same comment to a board more than once per day
  • SameUserTimeDelay—prevents user from posting another comment for period of time, specified in the SpamTimeSpan property.
  • SameMessageTimeDelay—prevents user from posting an identical comment for a period of time, specified in the SpamTimeSpan property.
  • Custom—Message Board uses your custom spam filter code. See Filtering Spam
• SpamTimeSpan (Integer)

  The number of seconds for which the SameUserTimeDelay or SameMessageTimeDelay spam filters delay a user from posting a second time. See Also: Filtering Spam.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  WARNING! If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• SuppressWrapperTags (Boolean)

  Suppresses the output of the span/div tags around the control.

  • True—Suppress wrap tags.
  • False (default)—Allow wrap tags.
• TemplateUserProfile (String)

  The URL path to a page that contains a UserProfile server control. The path can be relative or absolute. If you enter a path, a user can click any user’s name or avatar from the Message Board server control and be forwarded to his profile page. See illustration below.

  

  Note that user templates can be defined in the Ektron Workarea > Settings > Community Management > Templates screen. However, if you assign a template in this field, this setting takes precedence over the setting on the Workarea Template screen.

• WrapTag (String)

  Lets a developer specify a server control’s tag.

  • Span (default)—designate an inline portion of an HTML document as a span element.
  • Div—apply attributes to a block of code.
  • Custom—Lets you use a custom tag.