Metadata

Inserting the MetaData 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 MetaData 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:MetaData ID="MetaData1" runat="server" />

4. Click on MetaData 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—

   

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

• DefaultContentID (Long)

  Enter the ID of the content block whose metadata is added to the page. If you don’t know the ID number of the content block, use the CMS Explorer to browse to it.See also: Browsing your Ektron site using CMS Explorer. If you want to add metadata from several content blocks, set this property to 0 (zero) and use the DefaultItemList property to identify them.

• DefaultItemList (String)

  A bracket-separated list of content block IDs whose metadata added to the page. This list is used only if the DefaultContentID property is set to 0 (zero). For example:
  

  In the ID list, you can specify metadata definitions to exclude for each content block. To exclude a metadata definition, insert a semicolon after the ID and enter the metadata definition. For example,
  

  In the above example, the control will:

  • add all metadata definitions for content block 30
  • exclude the Title metadata definition for content block 10
  • exclude the Title and Description metadata definitions for content block 23

  Note the following criteria for metadata definitions that may be excluded:

  • the definition is case-sensitive, so must exactly match how the Name field of the Metadata Definitions screen.

    

  • The metadata definition type must be Meta Tag
• 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 content ID dynamically.

• GenerateDublinCore (Boolean)

  When enabled, this property automatically creates 7 of the Simple Dublin Core metadata fields from standard Ektron system properties. The default is false.

  • True. Generate Simple Dublin Core metadata fields
    
  • False. Do not generate Simple Dublin Core metadata fields

  The 7 fields and how they are associated with the Ektron properties is explained in Applying Simple Dublin Core Metadata

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

1. Drag a MetaData server control onto a template.
2. Set the properties of the Metadata server control. This will create the following HTML in the HTML body.

   <cms:MetaData id="MetaData1" runat="server" DefaultContentID="12"></cms:MetaData>

   Or, if you are using multiple content block IDs in the DefaultItemList, the following HTML is created.

   <cms:metadata id="MetaData1" runat="server" DefaultItemList="[12,7,4]">
     </cms:metadata>

3. Click the HTML tab and copy that line from the <body> tag to the <head> tag.
   —Image—

   

4. Save the Web form and rebuild the solution.
5. Open the Web page in the browser.
6. Right click the Web page and click View Source.
7. In the <head> tag, you see meta tags from the content block added to the page, as shown in the following image.
   —Image—