CommunityDocuments Server Control

Part of the Community Platform, this server control lets users create and upload either individual user content to the user profile or group content to the group profile. The content can be HTML content or an asset, such as a .PDF document or a .jpeg file.

The control displays a list of uploaded content filtered by category. In addition, a logged-in member can manage files, create categories, and decide which users can view the documents. This server control is typically placed on a user’s or a group profile page.

NOTE: When you drag and drop this control on a Web form in Visual Studio, the following message appears in the label of the control: “Workspace for user does not exist”. This happens because no ID is assigned to the control. When you assign an ID, the control’s name and the ID are displayed. If you use the DynamicParameter property to dynamically pass an ID from the QueryString, the above message appears because an ID is not assigned to the control.

Using the CommunityDocuments Server Control in an Individual User Profile

Adding folders to your workspace

Adding Folders to Your Workspace

  1. On the Web site, navigate to a User’s Profile Page > Workspace.
  2. Click Manage Folder (). The Add Folder box appears.
  3. Enter a Name for the folder.
  4. Determine with whom you want to share the folder's documents. For a description of the Share options, see Sharing Workspace Content.
  5. Click Add. The page refreshes and displays the newly added folder.
Editing a folder name in your workspace

Editing a Folder Name in Your Workspace

  1. On the Web site, navigate to a User’s Profile Page > Workspace.
  2. Click Edit (), located to the left of the folder’s title. The Edit Folder dialog appears.
  3. Change the name of the folder.
  4. Click Save. The page refreshes and shows the folder's new name.
Deleting a folder from your workspace

Deleting a Folder from Your Workspace

NOTE: You can not delete the top-level folder, Workspace.

WARNING! Deleting a folder permanently deletes the assets and HTML content in the folder, and its subfolders.

  1. On the Web site, navigate to a User’s Profile Page > Workspace.
  2. Click Edit (), located to the left of the folder’s title. The Edit Folder dialog appears.
  3. Click Delete. A dialog box asks you to confirm.
  4. Click OK.
Adding assets to a workspace

Adding Assets to a Workspace

Assets are files that are not HTML content, such as an Office document or PDF.

  1. On the Web site, navigate to a User’s Profile Page > Workspace.
  2. Select a folder to which the asset will be added. If you want to create a new folder, see Adding Folders to Your Workspace
  3. Click Add Asset (). The Add Asset box appears. Its appearance varies depending on your browser, and so on. To learn about these variations, see Managing Microsoft Office Assets.
  4. Import one or more assets, depending on the screen. A status box shows the files being uploaded and then the asset(s) appear in the file list.
Creating HTML content in your workspace

Creating HTML Content in Your Workspace

  1. On the Web site, navigate to a User’s Profile Page > Workspace.
  2. Select a folder where the content will be added. If you want to create a new folder, see Adding Folders to Your Workspace
  3. Click Add HTML Content (). The Add HTML Content window appears.
  4. Add a title and content.
  5. Click Publish to publish the content.
  6. The HTML content appears in the file list.
Moving and copying content in your workspace

Moving and Copying Content in Your Workspace

You can move or copy assets and HTML content from one folder to another. To accomplish either action:

  1. On the Web site, navigate to a User’s Profile Page > Workspace.
  2. Select the folder from which to move or copy the content.
  3. Click the drop-down triangle to the right of the content title.

  4. From the drop-down list, select Copy.
  5. Select the folder to which the content will be moved.
  6. Click Manage.
  7. Click Move Items () or Copy (). A dialog box asks you to confirm.
  8. Click OK. The moved or copied content appears in the folder.
Sharing workspace content

Sharing Workspace Content

The Workspace area allows users to share content with colleagues. Users can share content with the Public, Colleagues, Selected Colleagues or keep the content private.

Users apply sharing options to folders, not individual content items. To share a folder:

  1. On the Web site, navigate to a user’s or community group's Profile Page > Workspace.
  2. Locate the folder you want to share.
  3. Click Manage Folder (). The Add or Share Folder dialog box appears.
  4. Click Share Folder () in the top right corner. The Share Folder dialog box appears.
  5. Select with whom to share your folders.
  6. Click Share.

Documents in the folder are now available for viewing by the selected viewer type.

Using the CommunityDocuments Server Control with a Group Profile

Adding folders to the group workspace

Adding Folders to the Group Workspace

Community group members can add folders to the Workspace to help organize items in the Documents area.

  1. On the Web site, navigate to a community group’s Profile Page > Workspace.
  2. Click Manage Folder (). The Add Folder dialog appears.
  3. Enter a Name for the folder.
  4. Determine with whom you want to share the folder's documents.
    • Public—anyone can view and edit the document
    • Private—only group members can view and edit the document

    NOTE: If you want to later change a folder's share setting, follow the directions in Sharing Workspace Content.

  5. Click Add. The page refreshes and displays the newly added folder.
Editing a folder in a group workspace

Editing a Folder Name in a Group Workspace

  1. On the Web site, navigate to a community group Profile Page > Workspace.
  2. Click Edit (), located to the left of the folder’s title. The Edit Folder dialog appears.
  3. Change the name of the folder.
  4. Click Save. The page refreshes and shows the folder's new name.
Deleting a folder from a group workspace

Deleting a Folder from a Group Workspace

NOTE: You can not delete the top-level folder, Workspace.

WARNING! Deleting a folder permanently deletes all of the assets and HTML content in the folder, as well as its subfolders.

  1. On the Web site, navigate to a community group's Profile Page > Workspace.
  2. Click Edit (), located to the left of the folder’s title. The Edit Folder dialog appears.
  3. Click Delete. A dialog box asks you to confirm.
  4. Click OK.
CommunityDocuments server control properties

CommunityDocuments 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.

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

  • DynamicContentBoxHeight (Integer)

    The height of the dynamic content box in pixels

  • DynamicContentBoxWidth (Integer)

    The Width of the dynamic content box in pixels

  • DynamicContentTemplate (String)

    The template to use when displaying dynamic content. Leave blank to use the dynamic box.

  • DynamicParameter (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.
  • IncludeIcon (Boolean)

    Choose whether to display icons next to the navigation list’s links.

    • True—Show icons
    • False—Hide icons

  • ItemSortOrder

    Specify the sort order of results. Choices are:

    • taxonomy_item_display_order—the order of taxonomy items as set in the Workarea. For additional information, see Changing the Order of Content Assigned to a Taxonomy/Category
    • content_title—content ordered in alphabetical order by title
    • date_created—content ordered in the chronological order by creation date
    • last_edit_date—content ordered in the chronological order by last edit date.

    You can specify the direction of the items with the SortDirection property.

  • Language (Integer)

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

  • LinkTarget (String)

    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)

    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.

  • ObjectType (CommunityDocumentsObjectType)

    The type of object to which this control is assigned. Choices are:

    • User—this control is assigned to an individual.
    • Group—this control is assigned to a community group.
  • ShowCount (Boolean)

    Determines if an integer representing the number of items in a category appears next to the category.

    • True—Show items number next to category
    • False (default)—Do not show items number next to category

  • SortDirection (String)

    Select the direction of the itemSortOrder property. Choose Ascending or Descending.

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

  • TaxonomyCols (Integer)

    Enter the number of columns in which this taxonomy/category appear on the page.

  • TaxonomyItemCols (Integer)

    Enter the number of columns in which the taxonomy item appears on the page.

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