Description

Scriptable version of Submit Button of the HTML form. Depending of 'action' attribute it may have variants. In some of these variants the button will not have a submit function, as in select and browse buttons. In these cases the button will use client JavaScript to pop up new windows or for setting values in other windows.

Attributes

name = SqlName .  A page level unique name identifying a control.

annotation.  A human readable comment.

initial-enable = CalculateableValue .  Determines whether a control is initially visible. True by default. Could be data-bound to an SQL expression.

enabled = CalculateableValue .  Determines whether a control is visible. True by default. Could be data-bound to an SQL expression.

instantiate = CalculateableValue .  Determines whether a control instantiate its children. It is true by default. It could be data-bound to an SQL expression. Unlike most of calcucateable attributes, the value of this attribute for a control is calcluated before calling 'on-init' event handler of the control; other values are calculated before calling 'before-data-bind' event handler.

control-udt = SqlName .  At run time every control is represented as an instance of some user-defined type (UDT). VSPX compiles selects the UDT to use depending on name of the XML element that represents the control and maybe some of its attributes. In some specific cases the application developer may instruct VSPX compiler to use some other UDT, e.g. an application-specific UDT that is derived from the preset one. If specified, the value of 'control-udt' attribute should be equal to the name of the desired target UDT.

xsd-stub-xhtml.  This attribute is for internal use only. It has no effect if added to the source VSPX file.

width.  Visible width of the control when it is displayed in WYSIWYG tools when the source VSPX text is edited. The value of this attribute will not be used when the resulting HTML is rendered.

height.  Visible width of the control when it is displayed in WYSIWYG tools when the source VSPX text is edited. The value of this attribute will not be used when the resulting HTML is rendered.

column = SqlName .  The name of the column bound. If nothing else is specified, the column meta data from the containing update form sets the field's attributes.

null-value.  This value will be shown if value of the column is NULL, also value of the control will be set to null if this value is passed upon POST request.

action.  This specifies the button subclass to use.

value = CalculateableValue .  Text of the label of the button.

style.  A style of button, affects appearance.

active = CalculateableValue .  A data bound value to enable or disable the button. The default is '1' meaning 'enable'.

initial-active = CalculateableValue .  A data bound value to enable or disable the button. The default is '1' meaning 'enable'. Unlike 'active' attribute, this one is effective only when the page is displayed in the first time, not after user posts data back to the page.

child-window-options.  Options for oppening a child pop-up window.This can be used only in conjuction with action browse.

browser-current.  Current directory of browsing. Can be used only with browse button for WebDAV or File system resources.

browser-filter.  Filter expression(s) for browsing. (see above)

browser-list.  Type of browser list, 0 - short, 1 - long

browser-mode.  COL, RES or STANDALONE , for a file system or DAV browse button, this specifies whether to return an path name or internal ID.

browser-type.  This designates the type of browser: dav or OS (filesystem).

browser-xfer.  For a browse button, this is the means of transferring the data between windows, DOM is default. No other options in current implementation.

selector.  For a browse button this is the URL that will be loaded into the pop up window.

format = CalculateableValue .  A sprintf format string for printing the value

debug-srcfile.  URI of the source document where the tag comes from.

debug-srcline.  Line number in the source document where the tag comes from.

debug-log.  This defines what sort of data are saved to the debugging log.

Declaration of type vspx_button

Button class, encapsulate all controls originating a event

create type vspx_button under vspx_field as
(
  bt_pressed int default 0,
  bt_style  varchar default 'submit',
  bt_close_img varchar,
  bt_open_img varchar,
  bt_url varchar default '',
  bt_l_pars varchar default '',
  bt_text varchar default '',
  bt_anchor int default 0
)  temporary self as ref
overriding method vc_render () returns any,
overriding method vc_xrender () returns any,
overriding method vc_set_model () returns any,
constructor method vspx_button (name varchar, parent vspx_control)

Examples

<v:page name="button__0" xmlns:v="http://http://example.com/vspx/">
  <html>
    <head>
      <title>VSPX samples | v:button</title>
    </head>
    <body>
      <v:form name="form1" type="simple" action="" method="POST">
        <v:text name="txt1" default=""/>
        <v:button name="submit1" action="simple" style="image" xhtml_alt="A test button" value="--'plus.gif'" />
      </v:form>
    </body>
  </html>
</v:page>

<v:page name="button__1" xmlns:v="http://http://example.com/vspx/">
  <html>
    <head>
      <title>VSPX samples | v:button</title>
    </head>
    <body>
      <v:form name="f1" type="simple" action="" method="POST">
	<v:label name="l1" value="--0" format="%.2f" /><br/>
        <v:text name="t1" default="0"/>
        <v:text name="t2" default="0"/>
        <v:button name="b1" action="simple" value="Add" >
	<v:on-post>
	 self.l1.ufl_value := atof (self.t1.ufl_value) + atof (self.t2.ufl_value);
	</v:on-post>
	</v:button>
      </v:form>
    </body>
  </html>
</v:page>

<v:page name="browse__2" xmlns:v="http://http://example.com/vspx/">
  <v:form name="f1" type="simple" method="POST">
      <v:text name="floc" value="" xhtml_size="60%" />
      <v:button action='browse' name="cmb" selector="browser/dav_browser.vsp"
		child-window-options="resizable=yes, status=no, menubar=no, scrollbars=no, width=640, height=400"
		value="Browse"
		browser-type="os"
		browser-mode="RES"
		browser-xfer="DOM"
		browser-list="1"
		browser-current="1"
		browser-filter="*">
        <v:field name="floc" />
      </v:button>
  </v:form>
</v:page>
</body>
</html>

<v:page name="button__3" xmlns:v="http://http://example.com/vspx/">
  <v:form name="frm" type="simple" method="POST">
      <v:text name="fld1" value="" />
      <v:text name="fld2" value="" />
      <v:button action='browse' name="br1" selector="button__4.vspx"
		child-window-options="scrollbars=yes, menubar=no, height=630, width=600"
		value="Browse">
        <v:field name="fld1" />
        <v:field name="fld2" />
      </v:button>
  </v:form>
</v:page>
</body>
</html>

<v:page name="button__4" xmlns:v="http://http://example.com/vspx/">
  <v:form name="f1" type="simple" method="POST">
     <v:text name="sl1" value="Test" />
     <v:select-list name="sl2">
       <v:item name="*default*" value="0" />
       <v:item name="FIRST" 	value="1" />
       <v:item name="SECOND" 	value="2" />
     </v:select-list>
	<v:button name="select1" action="return" value="Select">
	  <v:field name="fld1" ref="sl1" />
	  <v:field name="fld2" ref="sl2" />
	</v:button>
 </v:form>
</v:page>
</body>
</html>

	See Also: Reference Material in the Tutorial:
	VX-S-2 VX-S-7