ImageControl

The ImageControl server control, when viewed on a Web form, displays an image stored within the Ektron Document Management feature. If you log in and have permission to edit the image, you can right click the image and select Edit. This action displays a dialog box with which the user can update the image.

IMPORTANT: Images are stored as assets using the Document Management feature. This control does not use the Ektron Library.

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

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

  • DefaultImageID (Long)

    The image asset’s content ID you want to display. If you don’t know the ID number of the asset, use the CMS Explorer to browse to it.

  • 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 an image asset’s ID dynamically. To have the default image ID used, leave blank.

  • FolderID (Long)

    The ID of the folder where images are added. If you don’t know the ID number of the folder, use the CMS Explorer to browse to it.

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

  • SuppressWrapperTags (Boolean)

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

    • True. Suppress wrap tags.
    • False (default). Allow wrap tags.
  • TaxonomyID (long)

    The ID of the 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. to which assets are added.

  • Title (String)

    Set the image’s alt/title text. By default, the image file name is used.

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