Inserting the CommunityGroupMembers server control onto a page

Prerequisite

You must have installed the server controls. See Installing server controls into Visual Studio Toolbox.

1. In Visual Studio, choose View > Toolbox.
2. Click the Ektron server control tab to display the server controls.
3. Drag the CommunityGroupMembers server control and drop it into the desired location on the page.

   NOTE: You also can place the cursor on the page where you want the server control, then double click the server control that you want.

   <CMS:CommunityGroupMembers ID="CommunityGroupMembers1" runat="server" />

4. Click on CommunityGroupMembers in the code to display and modify the control’s properties using the Properties window of Visual Studio. The page is updated as you modify the property values.
   —Image—

   

CommunityGroupMembers properties

The following are Ektron-specific server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. properties. For information about native .NET properties such as font, height, width and border style, use Visual Studio^® help.

• AvatarHeight (Integer)

  The display height (in pixels) of the avatar in the results box.

• AvatarWidth (Integer)

  The display width (in pixels) of the avatar in the results box.

• CacheInterval (Double)

  The number of seconds that a server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified.’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.

• DefaultCommunityGroupID (Long)

  The default community group ID for this control to use if no matching dynamic parameter value is passed.

• DisplayMode (eDisplayMode)

  Select whether this control displays a community group’s current members or their pending members. Choices are:

  • Members. Current group members
  • PendingMembers. Users who asked or were invited to join the group
• DisplayXslt (String)

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

  WARNING! Files stored in the siteroot\Workarea folder are overwritten (or deleted) when you upgrade Ektron. To avoid problems, copy the default file to a folder outside the siteroot\workarea folder then edit it. If there is no default file, create the file outside the siteroot\workarea folder. Next, in this property, enter the path to that file relative to the site root folder.

  WARNING! 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.

• DynamicParameter (String)

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

• 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).

• Link (String)

  Add a link to the member profile page’s Web form. This allows a user to click a link in the community group members list and be taken to a member’s profile page. Two 2 variables used within the link represent the user’s ID and name.

  • {0}. User ID
  • {1}. User name

  The link needs both variables. The Web form can be relative or absolute. For example:

  userprofilepage.aspx?gid={0}&gn={1}

• LinkTarget (ItemLinkTargets)

  Determines the type of window that appears when you click a link in the server control.

  • _Self (default). Opens in same window.
  • _Top. Opens in parent window.
  • _Blank. Opens in new window.
  • _Parent. Opens in the parent frame.
• MarkupLanguage (String)

  Enter the template markup file (.ekml) that controls the display of this server control. To use the default .ekml file, leave this field blank.

  The default file follows this pattern: \siteroot\Workarea\template\this object\objectname.ekml. For example, \siteroot\Workarea\template\collection\collection.ekml.

  To customize the default .ekml file, copy it to a folder outside the siteroot\workarea folder and edit it. Next, in this property, enter the path to that file relative to the site root folder.

  See also: Ektron Markup Language

• MaxResults (Integer)

  The maximum number of items to fetch. 0 (zero) = unlimited.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. Leave blank to use the default style sheet. To use a custom style sheet, place it in a folder outside the siteroot\workarea folder then edit it. Next, in this property, enter the path to the custom style sheet relative to the site root folder.

  NOTE: 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.
• 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.