<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html>
<head profile="http://internetalchemy.org/2003/02/profile">
<link rel="foaf" type="application/rdf+xml" title="FOAF" href="http://www.openlinksw.com/dataspace/uda/about.rdf" />
<link rel="schema.dc" href="http://purl.org/dc/elements/1.1/" />
<meta name="dc.title" content="OpenLink Virtuoso Universal Server: Documentation" />
<meta name="dc.subject" content="OpenLink Virtuoso Universal Server: Documentation" />
<meta name="dc.creator" content="OpenLink Software Documentation Team ; " />
<meta name="dc.copyright" content="OpenLink Software, 1999 - 2009" />
<link rel="top" href="index.html" title="OpenLink Virtuoso Universal Server: Documentation" />
<link rel="search" href="/doc/adv_search.vspx" title="Search OpenLink Virtuoso Universal Server: Documentation" />
<link rel="parent" href=".html" title="Chapter Contents" />
<link rel="prev" href="index.html" title="Home" />
<link rel="next" href="contents.html" title="Contents" />
<link rel="shortcut icon" href="../images/misc/favicon.ico" type="image/x-icon" />
<link rel="stylesheet" type="text/css" href="doc.css" />
<link rel="stylesheet" type="text/css" href="/doc/translation.css" />
<title>OpenLink Virtuoso Universal Server: Documentation</title>
<meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8" />
<meta name="author" content="OpenLink Software Documentation Team ; " />
<meta name="copyright" content="OpenLink Software, 1999 - 2009" />
<meta name="keywords" content="" />
<meta name="GENERATOR" content="OpenLink XSLT Team" />
</head>
<body>
<div id="header">
<a name="vc_button" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>OpenLink Virtuoso Universal Server: Documentation - button</h1>
</div>
<div id="navbartop">
<div>
<a class="link" href="functions.html">Chapter Contents</a> | <a class="link" href="index.html" title="Home">Prev</a> | <a class="link" href="contents.html" title="Contents">Next</a>
</div>
</div>
<div id="currenttoc">
<form method="post" action="/doc/adv_search.vspx">
<div class="search">Keyword Search: <br />
<input type="text" name="q" /> <input type="submit" name="go" value="Go" />
</div>
</form>
<div>
<a href="http://www.openlinksw.com/">www.openlinksw.com</a>
</div>
<div>
<a href="http://docs.openlinksw.com/">docs.openlinksw.com</a>
</div>
<br />
<div>
<a href="index.html">Book Home</a>
</div>
<br />
<div>
<a href="contents.html">Contents</a>
</div>
<div>
<a href="preface.html">Preface</a>
</div>
<br />
<div>
<a href="overview.html">Overview</a>
</div>
<div>
<a href="installation.html">Installation Guide</a>
</div>
<div>
<a href="quicktours.html">Quick Start & Tours</a>
</div>
<div>
<a href="sampleapps.html">Sample ODBC & JDBC Applications</a>
</div>
<div>
<a href="concepts.html">Conceptual Overview</a>
</div>
<div>
<a href="server.html">Administration</a>
</div>
<div>
<a href="accessinterfaces.html">Data Access Interfaces</a>
</div>
<div>
<a href="sqlreference.html">SQL Reference</a>
</div>
<div>
<a href="sqlprocedures.html">SQL Procedure Language Guide</a>
</div>
<div>
<a href="hooks.html">Database Event Hooks</a>
</div>
<div>
<a href="repl.html">Data Replication, Synchronization and Transformation Services</a>
</div>
<div>
<a href="webappdevelopment.html">Web Application Development</a>
</div>
<div>
<a href="webandxml.html">XML Support</a>
</div>
<div>
<a href="rdfandsparql.html">RDF Data Access and Data Management</a>
</div>
<div>
<a href="webservices.html">Web Services</a>
</div>
<div>
<a href="runtimehosting.html">Runtime Hosting</a>
</div>
<div>
<a href="internetservices.html">Internet Services</a>
</div>
<div>
<a href="freetext.html">Free Text Search</a>
</div>
<div>
<a href="tpcc.html">TPC C Benchmark Kit</a>
</div>
<div>
<a href="xa.html">Using Virtuoso with Tuxedo</a>
</div>
<div>
<a href="appendixa.html">Appendix</a>
</div>
<div>
<a href="functions.html">Virtuoso Functions Guide</a>
</div>
<br />
</div>
<div id="text">
<h2>button</h2>
<div class="refpurpose">Scriptable button.</div>
<div class="funcsynopsis">
<span class="funcdef">
<<a href="vc_button.html">
<span class="function">button</span>
</a>
name (required)
annotation (optional)
initial-enable (optional)
enabled (optional)
instantiate (optional)
control-udt (optional)
xsd-stub-xhtml (optional)
width (optional)
height (optional)
column (optional)
null-value (optional)
action (required)
value (required)
style (optional)
active (optional)
initial-active (optional)
child-window-options (optional)
browser-current (optional)
browser-filter (optional)
browser-list (optional)
browser-mode (optional)
browser-type (optional)
browser-xfer (optional)
selector (optional)
format (optional)
debug-srcfile (optional)
debug-srcline (optional)
debug-log (optional)
/></span>
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>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.
</p>
</div>
<div class="refsect1">
<div class="refsect1title">Attributes</div>
<div class="formalpara">
<strong>name = <a href="vc_type_SqlName.html">SqlName</a>
</strong>
<p>A page level unique name identifying a control.</p>
</div>
<div class="formalpara">
<strong>annotation</strong>
<p>A human readable comment.</p>
</div>
<div class="formalpara">
<strong>initial-enable = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>Determines whether a control is initially visible. True by default. Could be data-bound to an SQL expression.</p>
</div>
<div class="formalpara">
<strong>enabled = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>Determines whether a control is visible. True by default. Could be data-bound to an SQL expression.</p>
</div>
<div class="formalpara">
<strong>instantiate = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>control-udt = <a href="vc_type_SqlName.html">SqlName</a>
</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>xsd-stub-xhtml</strong>
<p>This attribute is for internal use only. It has no effect if added to the source VSPX file.</p>
</div>
<div class="formalpara">
<strong>width</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>height</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>column = <a href="vc_type_SqlName.html">SqlName</a>
</strong>
<p>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.
</p>
</div>
<div class="formalpara">
<strong>null-value</strong>
<p>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.
</p>
</div>
<div class="formalpara">
<strong>action</strong>
<p>This specifies the button subclass to use.</p>
<table class="data">
<caption>Table: 12.4.9.1. Allowed values of the 'action' attribute</caption>
<tr>
<td class="data">simple</td>
<td class="data">
<p>is a simple submit button, no special functions
</p>
</td>
</tr>
<tr>
<td class="data">submit</td>
<td class="data">
<p>an alias of 'simple' button, obsolete
</p>
</td>
</tr>
<tr>
<td class="data">delete</td>
<td class="data">
<p>a button for deleting a row in a data-set or data-grid control. This is represented as a submit button with a special on-post script. The delete function is performed based on table, key attributes. (check implementation!!)
</p>
</td>
</tr>
<tr>
<td class="data">browse</td>
<td class="data">
<p>Button that opens pup-up window using client-side javascript (browse-button).
This control allows the designer to place some part of a form's input into a pop-up window. When the HTML page is rendered, this control puts a button and associated client-side javascript into the resulting page so clicking the button opens a child window. </p>
</td>
</tr>
<tr>
<td class="data">return</td>
<td class="data">
<p>
This is to be used on a page invoked for selecting from a browse button. Specifies that the value of the fields designated by the field children are to be asigned to the corresponding fields of the invoking page.
</p>
</td>
</tr>
<tr>
<td class="data">logout</td>
<td class="data">
<p> This will terminate the current session when clicked. Can only occur inside the login control.
</p>
</td>
</tr>
</table>
<br />
</div>
<div class="formalpara">
<strong>value = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>Text of the label of the button.</p>
</div>
<div class="formalpara">
<strong>style</strong>
<p>A style of button, affects appearance.</p>
<table class="data">
<caption>Table: 12.4.9.1. Allowed values of the 'style' attribute</caption>
<tr>
<td class="data">submit</td>
<td class="data">
<p>This is a default style used, no special handling.
The button will be rendered as a usual submit button.
</p>
</td>
</tr>
<tr>
<td class="data">url</td>
<td class="data">
<p>The button will be rendered as a link, furthermore client side JavaScript code will be produced to act as submit button. </p>
</td>
</tr>
<tr>
<td class="data">image</td>
<td class="data">
<p>The button will be rendered as an image on the browser under link button. In that case value of button control must be link to the image file.
</p>
</td>
</tr>
</table>
<br />
</div>
<div class="formalpara">
<strong>active = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>A data bound value to enable or disable the button. The default is '1' meaning 'enable'.</p>
</div>
<div class="formalpara">
<strong>initial-active = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>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.</p>
</div>
<div class="formalpara">
<strong>child-window-options</strong>
<p>Options for oppening a child pop-up window.This can be used only in conjuction with action browse.</p>
</div>
<div class="formalpara">
<strong>browser-current</strong>
<p>Current directory of browsing. Can be used only with browse button for WebDAV or File system resources.</p>
</div>
<div class="formalpara">
<strong>browser-filter</strong>
<p>Filter expression(s) for browsing. (see above)</p>
</div>
<div class="formalpara">
<strong>browser-list</strong>
<p>Type of browser list, 0 - short, 1 - long</p>
</div>
<div class="formalpara">
<strong>browser-mode</strong>
<p>COL, RES or STANDALONE , for a file system or DAV browse button, this specifies whether to return an path name or internal ID.
</p>
</div>
<div class="formalpara">
<strong>browser-type</strong>
<p>This designates the type of browser: dav or OS (filesystem).</p>
</div>
<div class="formalpara">
<strong>browser-xfer</strong>
<p>For a browse button, this is the means of transferring the data between windows, DOM is default. No other options in current implementation.</p>
</div>
<div class="formalpara">
<strong>selector</strong>
<p>For a browse button this is the URL that will be loaded into the pop up window.</p>
</div>
<div class="formalpara">
<strong>format = <a href="vc_type_CalculateableValue.html">CalculateableValue</a>
</strong>
<p>A sprintf format string for printing the value</p>
</div>
<div class="formalpara">
<strong>debug-srcfile</strong>
<p>URI of the source document where the tag comes from.</p>
</div>
<div class="formalpara">
<strong>debug-srcline</strong>
<p>Line number in the source document where the tag comes from.</p>
</div>
<div class="formalpara">
<strong>debug-log</strong>
<p>This defines what sort of data are saved to the debugging log.
</p>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Declaration of type vspx_button</div>
<p>
Button class, encapsulate all controls originating a event
</p>
<div>
<pre class="screen">
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)
</pre>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="vc_ex_button__0" />
<div class="example">
<div class="exampletitle">
Buton shown as an image
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: button__0.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
The button of the form will be shown as a picture plus.gif. Attributes whose names start with 'xhtml_' are
placed into the resulting HTML with no changes.
</p>
<div>
<pre class="screen">
<v:page name="button__0" xmlns:v="http://www.openlinksw.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>
</pre>
</div>
</div>
<a name="vc_ex_button__1" />
<div class="example">
<div class="exampletitle">
Simple 'Add-Number' example
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: button__1.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
The form accepts two numbers and calculates their sum.
</p>
<div>
<pre class="screen">
<v:page name="button__1" xmlns:v="http://www.openlinksw.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>
</pre>
</div>
</div>
<a name="vc_ex_button__2" />
<div class="example">
<div class="exampletitle">
Simple 'Browse File' dialog
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: button__2.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
The form allows to select a file from server's file system
<html>
<body>
</p>
<div>
<pre class="screen">
<v:page name="browse__2" xmlns:v="http://www.openlinksw.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>
</pre>
</div>
</div>
<a name="vc_ex_button__3" />
<div class="example">
<div class="exampletitle">
Simple browse button example
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: button__3.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
The form allows to select a two values from a different page
<html>
<body>
</p>
<div>
<pre class="screen">
<v:page name="button__3" xmlns:v="http://www.openlinksw.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>
</pre>
</div>
</div>
<a name="vc_ex_button__4" />
<div class="example">
<div class="exampletitle">
Simple select button example
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: button__4.vspx,v 1.2 2006/08/16 00:04:15 source Exp $
-
- This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
- project.
-
- Copyright (C) 1998-2006 OpenLink Software
-
- This project is free software; you can redistribute it and/or modify it
- under the terms of the GNU General Public License as published by the
- Free Software Foundation; only version 2 of the License, dated June 1991.
-
- This program is distributed in the hope that it will be useful, but
- WITHOUT ANY WARRANTY; without even the implied warranty of
- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
- General Public License for more details.
-
- You should have received a copy of the GNU General Public License along
- with this program; if not, write to the Free Software Foundation, Inc.,
- 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
-
-
The form returns back to caller form two walues from a text box and select list
<html>
<body>
</p>
<div>
<pre class="screen">
<v:page name="button__4" xmlns:v="http://www.openlinksw.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>
</pre>
</div>
</div>
</div>
<div class="tip">
<div class="tiptitle">See Also: Reference Material in the Tutorial:</div>
<p>
<a href="/tutorial/web/vx_s_2/form.vspx">VX-S-2</a>
</p>
<p>
<a href="/tutorial/web/vx_s_7/products.vspx">VX-S-7</a>
</p>
</div>
</div>
<div id="footer">
<div>Copyright© 1999 - 2009 OpenLink Software All rights reserved.</div>
<div id="validation">
<a href="http://validator.w3.org/check/referer">
<img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" />
</a>
<a href="http://jigsaw.w3.org/css-validator/">
<img src="http://jigsaw.w3.org/css-validator/images/vcss" alt="Valid CSS!" height="31" width="88" />
</a>
</div>
</div>
</body>
</html>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
71d40963b505df4524269198e237b3e3
>
files
>
917
