<!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_vscx" />
<img src="../images/misc/logo.jpg" alt="" />
<h1>OpenLink Virtuoso Universal Server: Documentation - vscx</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>vscx</h2>
<div class="refpurpose" />
<div class="funcsynopsis">
<span class="funcdef">
<<a href="vc_vscx.html">
<span class="function">vscx</span>
</a>
name (required)
annotation (optional)
initial-enable (optional)
enabled (optional)
instantiate (optional)
control-udt (optional)
xsd-stub-xhtml (optional)
width (optional)
height (optional)
url (required)
debug-srcfile (optional)
debug-srcline (optional)
debug-log (optional)
/></span>
</div>
<div class="refsect1">
<div class="refsect1title">Description</div>
<p>Custom control encapsulated in a separate VSPX page. This is a
wrapper for custom control instantiation. The target URL MUST contain
a valid VSPX page reference. In this way repeatable pieces of code can be reused in
form of instantiation of their page class, this is different from inclusion.
The target page variables can be initialized as attributes in this control, where
name of attribute is a name of variable of target page and value is
an expression to be assigned.
</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>url</strong>
<p>Reference to a VSPX page to be instantiated as a control.</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_vscx</div>
<p>
</p>
<div>
<pre class="screen">
create type vspx_vscx under vspx_form
self as ref temporary
constructor method vspx_vscx (name varchar, parent vspx_control, uri varchar),
overriding method vc_pre_render (stream any, n int) returns any
</pre>
</div>
</div>
<div class="refsect1">
<div class="refsect1title">Examples</div>
<a name="vc_ex_vscx__0" />
<div class="example">
<div class="exampletitle">
Outer page, including a navigation bar via vscx__1.vspx
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: vscx__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
-
-
This page will embed another page twice, but not as simple inclusion. The
second page is treated as a control and it's page class will be instantiated twice as
as a child of outer page.
</p>
<div>
<pre class="screen">
<v:page name="outer_page" xmlns:v="http://www.openlinksw.com/vspx/">
<html>
<body>
<v:variable name="var1" type="int" default="0" />
<h3>Embeeding a page as a custom control</h3>
<v:form type="simple" name="f1">
<div>
<div>control1</div>
<v:vscx name="bar1" url="vscx__1.vspx"/>
</div>
<div>
<div>control2</div>
<v:vscx name="bar2" url="vscx__1.vspx"/>
</div>
<div>
<v:text name="txt2" />
<v:button action="simple" value="Outer" name="b2" />
</div>
</v:form>
</body>
</html>
</v:page>
</pre>
</div>
</div>
<a name="vc_ex_vscx__1" />
<div class="example">
<div class="exampletitle">
Simple navigation bar used as custom control
</div>
<p>
<?xml version="1.0"?>
<!--
-
- $Id: vscx__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
-
-
This page is used inside vscx__0.vspx one as a custom control.
</p>
<div>
<pre class="screen">
<v:page name="custom_bar" xmlns:v="http://www.openlinksw.com/vspx/">
<v:variable name="test" type="int" default="12" />
<table border="1" cellspacing="1" cellpadding="0">
<tr>
<td>
<v:url name="u1" value="Home" url="--http_path ()" /> |
</td>
<td>
<v:url name="u2" value="Settings" url="--http_path ()||'?settings'" /> |
</td>
<td>
<v:url name="u3" value="Posts" url="--http_path ()||'?posts'" /> |
</td>
<td>
<v:url name="u4" value="Maintenance" url="--http_path ()||'?maint'" />
</td>
</tr>
</table>
<div>
<v:form type="simple" name="f1">
<v:text name="txt1" />
<v:button name="b1" action="simple" value="Inner"/>
</v:form>
</div>
</v:page>
</pre>
</div>
</div>
</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
>
968
