PhotoGallery

IMPORTANT: . The PhotoGallery 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. is deprecatedfunctionality that was improved upon by other functionality. If you are already using a deprecated item, you can continue to do so, but Ektron recommends using current versions of functionality.. If you are already using a deprecated item, you can continue to do so, but Ektron recommends using current versions of functionality.

The PhotoGallery server control helps users and community groups track and manage images.

Inserting the PhotoGallery 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 PhotoGallery 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:PhotoGallery ID="PhotoGallery1" runat="server" />
  4. Click on PhotoGallery 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.

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

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

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

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

  • GetAnalyticsData (Boolean)

    Set this property to True if you want the following information for each content in the list. Returns Content View Count, Content Rating, Content Rating Average. Create your own XSLT styles to display this data.

    IMPORTANT: This property provides reliable data only when the Business Analytics Feature is on. See Running Ektron Business Analytics.

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

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

    • True. Show icons
    • False. Hide icons
  • 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)

    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)

    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 (String)

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

    • User
    • Group
  • OrderItemsBy

    Specify the sort order of results. Choices are:

    To specify the direction of the items, use the SortDirection property.

  • ShowCount (Boolean)

    Indicates if an integer representing the number of taxonomy items in the category appears next to each category when displayed on the website. The default is False.

    • True. Show taxonomy items number
    • False. Do not show taxonomy items number
  • ShowRoot (Boolean)
    • False. Top represents the first node of the taxonomy path.
    • True. The name of the taxonomy path's first node appears instead of Top.

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

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

Using the PhotoGallery server control

IMPORTANT: The PhotoGallery 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. is deprecatedfunctionality that was improved upon by other functionality. If you are already using a deprecated item, you can continue to do so, but Ektron recommends using current versions of functionality.. If you are already using a deprecated item, you can continue to do so, but Ektron recommends using current versions of functionality.

The PhotoGallery server control helps users and community groups track and manage images. They can organize the images in any number of taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. categories. For example, a user might have the following organization.

  • Science
    • Biology
      • Animals
        • Mammals
          • Lions
          • Bears

After you upload an image to the a Photo Gallery, site visitors can navigate through its taxonomy and view the image.

When you associate this control with a community group, you can allow group members to add, remove and control the sharing of folders in a workspace. Because this feature is implemented on a group-by-group basis, it is controlled in the Workarea's Edit Community Group screen. See also: Allowing Community Group Members to Work with Folders.

Categories

Adding a category

You can add categories to your photo gallery to sort your photos. You also can use categories to identify the types of users who can view the photos. For example, one category of photos may be private, while another may be shared with all of your colleagues.

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Click Manage Folder (). The Add box appears.

  3. Enter a Name for the folder.
  4. In the Share area, select with whom you want to share your photos.
    • Public. Anyone who can access your profile
    • Colleagues. Only colleagues (either you accepted their invitation, or they accepted yours)
    • Selected Colleagues. Colleagues that you designated as selected. See also: Designating a selected colleague.
    • Private. Only you
  5. Click Add. When the page refreshes, it opens to the newly added folder.

Renaming a category

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Click Edit (), located to the left of the category’s title. The Edit box appears.
  3. Change the name of the category.
  4. Click Save.

Deleting a category

WARNING! Deleting a category permanently deletes all photos, as well as its subcategories.

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

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Click Edit (), located to the left of the category’s title. The Edit box appears.
  3. Click Delete. A dialog box appears asking you to confirm.
  4. Click OK.

Photos

Adding Photos to a photo gallery

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Select a category where the photo will be added. If you want to create a new category, see Adding a category
  3. Click Add Photo. The Add Photo box appears
  4. In the Photo Data area, enter a Description and Maximum Width.

  5. Click Next. The Add Photo dialog appears. Its appearance varies according to your browser, as explained in Storing External Files as Library Items vs. Assets.

  6. User the Browse or Choose File button to navigate to the photo in your file system. Or, you may be able to click the Drag Drop tab and drop a photo in the Add box. A status box shows the files being uploaded. The page refreshes, and the photo appears in the gallery.

Changing a photo title or description

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Select the category which contains the photo you want to change.
  3. Click the triangle to the right of the photo’s title and choose Edit Properties.
  4. Edit the photo’s Title, Description, or both.
  5. Click Save.

Moving and copying photos

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Select the category from which to move or copy the photo.
  3. Click the triangle to the right of the photo’s title and choose Copy.
  4. Select the category to which the photo will be moved and click Manage.
  5. Click Move or Copy. A dialog box asks you to confirm the action.
  6. Click OK.

Deleting a photo

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Select the category which contains the photo you want to delete.
  3. Click the triangle to the right of the photo’s title and choose Delete. A dialog box asks you to confirm.
  4. Click OK.

Sharing photos

The Photo Gallery lets you share photos with your colleagues. You can share photos with the Public, Colleagues, Selected Colleagues, or keep them private. You apply sharing options to categories, not individual photos. See also: Public. Anyone who can access your profile

  1. On the website, navigate to a user’s Profile Page > Photo Gallery.
  2. Click Manage Folder (). The Add box appears.

  3. Click Share Folder (). The Share Workspace box appears.

  4. Select with whom to share your photos.
    • Public. Anyone who can access your profile
    • Colleagues. Only colleagues (either you accepted their invitation, or they accepted yours)
    • Selected Colleagues. Colleagues that you designated as selected. See also: Designating a selected colleague.
    • Private. Only you
  5. Click Share.

Saving a photo to your local system

  1. On the website, navigate to a User’s Profile Page > Photo Gallery.
  2. Select the category that contains the photo you want to save.
  3. Click the triangle to the right of the photo’s title and choose Save As... A dialog box asks you to open or save the file.
  4. Click Save.