Documentation Center

lookup

This topic describes the lookup element.

Description

A <lookup> element is a mechanism for configuring the behavior of a lookup dialog that will open in Content Editor when you need users to input a value. The lookup configuration includes:

  • the target for the lookup , which can be any simpleType element as defined in your schema. The lookup can be used to obtain image URLs or links, or could also be used to select keywords, or author names from some list or repository.
  • a link to an HTML page that controls the interaction for getting the value. This can include setting up the table and obtaining values for the user to choose from, and at the end a call to the choose method to return the user's choice(s) to the editor.

Lookup dialogs open in iframes, thus behave asynchronously.

For more information and examples refer to:

Example: Looking up a url

This is a basic example using the <node> configuration with a reference to the index.html page that controls the lookup.
<x:node match="a/@href">
  <x:lookup 
    url="lookup/link/index.html"
    forceLookup="true"
    autoOpen="true"/>   
</x:node>

Namespace

http://www.xopus.com/xmlns/config

Attributes

NameDescription and useType
urlSpecify the page on the server to load in the lookup dialog.string
forceLookupOptional. Then forceLookup attribute is set to true, authors cannot edit the attribute for which the lookup dialog was specified manually using the properties editor; the input field will be disabled.boolean
autoOpenOptional. When set to true, it specifies that the lookup dialog should be opened automatically when appropriate. For example when the parent element is inserted and the attribute is required in the schema. When set to false, the lookup is only shown when it is requested from the button in the properties panel.boolean

Deprecated attributes ( These attributes were for use with the deprecated <lookupConfig> element)

NameDescription and useType
parentPatternOnly applies to <x:lookup> in <x:lookupConfig>.
The owner element of the lookup attribute. parentPattern contains an XPath query, using the owner element as context.
string
nameOnly applies to <x:lookup> in <x:lookupConfig>

Name of the lookup attribute.

string

Parent Elements

node

lookupConfig (deprecated)