Elements

element <Handle>
Namespace:
http://schema.caplin.com/CaplinTrader/webcentric
XML Representation Summary
<Handle
   
handle_height
 = 
 xs:integer
drag_action
 = 
 xs:string
drag_container
 = 
 xs:string
drop_target
 = 
 xs:string
style
 = 
 xs:string
align
 = 
 xs:string
    >
   
Content: 
Button*
</Handle>
Child elements (1):
Parent elements (1):
Description
This decorator is used to provide the user with a draggable strip along the top of another component. This Handle also displays the caption of the parent component. A Handle can also contain additional components such as buttons.
Attribute Detail
align
Type:
xs:string, predefined
Use:
optional
This value defines the alignment of this decorator relative to the main content area of the parent component. For example, 'top' means the Handle will be displayed along the top of the parent.
drag_action
Type:
xs:string, predefined
Use:
optional
This defines the manner in which this decorator and its parent component can be dragged. The value 'SNAP_FRAMEITEM' allows the component to be dragged and dropped on any other component that has the 'drop_target' attribute also set to 'SNAP_FRAMEITEM'. the value 'MDI_DRAG' allows the decorator and its parent component to be dragged and dropped anywhere.
drag_container
Type:
xs:string, predefined
Use:
optional
Identifies the container element that defines the drag boundaries for a drag operation. It is not possible to drag an element outside this constrained area. Individual draggable elements can define specific drag containers, though it is often more convenient to define this once for the entire application, on the application node. The value must be an xpath expression that, when evaluated, identifies a frameset or component.
drop_target
Type:
xs:string, predefined
Use:
optional
If this attribute is set to 'SNAP_FRAMEITEM' then other components being dragged can be dropped onto this decorator or component.
handle_height
Type:
xs:integer, predefined
Use:
optional
This defines the 'depth' of this decorator, which may be either the height or the width, depending on whether the alignment of the Handle is a horizontal alignment or vertical one. The default alignment is generally top (a horizontal alignment), but this varies from decorator to decorator (for example the default alignment of StatusBar is bottom). When alignment is top or bottom (that is, horizontal), handle_height defines the height, otherwise it defines the width.
style
Type:
xs:string, predefined
Use:
optional
Applies a custom class attribute to the HTML element that represents it, based on the name of this element and the value of the style attribute, and allows a custom view object to be used in JavaScript, again using the element name and style value. See the style attribute in the Stack element for more detail.