Elements

element <layout>
Namespace:
http://schema.caplin.com/CaplinTrader/layoutConfiguration
XML Representation Summary
<layout
   
name
 = 
 xs:string
src
 = 
 xs:string
defaultLayout
 = 
 xs:boolean
/>
Parent elements (1):
Description
Specifies a layout that is available to the application.
Attribute Detail
defaultLayout
Type:
xs:boolean, predefined
Use:
required
This attribute specifies whether or not the defined layout is a default one. When defaultLayout is "true", the layout is always displayed when the application starts up, and the user cannot subsequently close the layout. When defaultLayout is "false", the layout is not displayed by default; however, the user can manually open the layout (for example, from a menu), and can close it again. This attribute is ignored for any user who is named in a <user> tag where the layouts attribute is specified; in this case the layouts attribute of <user> determines whether or not the layout is displayed when the user logs on.
name
Type:
xs:string, predefined
Use:
required
The name of the layout (for example, "Foreign Exchange"). This name appears on the tab at the top of the rendered layout.
src
Type:
xs:string, predefined
Use:
required
The name of the XML file that defines the layout (for example, "Layout_FX.xml"). The name can include a directory path relative to the location of this User Layout configuration XML. A sub-directory called layouts is automatically prepended to the relative path. For example, assume this User Layout configuration XML is in a directory called /layout. If the src attribute is set to "xxx/Layout_FX.xml", the path to the layout XML file is /layout/layouts/xxx/Layout_FX.xml. If the src attribute is set to "Layout_FX.xml" (no relative path), the path to the layout XML file is /layout/layouts/Layout_FX.xml.