<refentry id="vc_vscx">
  <refmeta>
  <refentrytitle>vscx</refentrytitle>
  <refmiscinfo>vspx_control</refmiscinfo>
  </refmeta>
  <refnamediv>
  <refname>vscx</refname>
  <refpurpose />
  </refnamediv>
  <refsynopsisdiv>
   <funcsynopsis id="vc_syn_vscx">
    <funcprototype id="vc_proto_vscx">
      <funcdef>
            &lt;<function>vscx</function> <attribute>
          <parameter>name</parameter> (required) </attribute>
        <attribute>
          <parameter>annotation</parameter> (optional) </attribute>
        <attribute>
          <parameter>initial-enable</parameter> (optional) </attribute>
        <attribute>
          <parameter>enabled</parameter> (optional) </attribute>
        <attribute>
          <parameter>instantiate</parameter> (optional) </attribute>
        <attribute>
          <parameter>control-udt</parameter> (optional) </attribute>
        <attribute>
          <parameter>xsd-stub-xhtml</parameter> (optional) </attribute>
        <attribute>
          <parameter>width</parameter> (optional) </attribute>
        <attribute>
          <parameter>height</parameter> (optional) </attribute>
        <attribute>
          <parameter>url</parameter> (required) </attribute>
        <attribute>
          <parameter>debug-srcfile</parameter> (optional) </attribute>
        <attribute>
          <parameter>debug-srcline</parameter> (optional) </attribute>
        <attribute>
          <parameter>debug-log</parameter> (optional) </attribute>
 /&gt;</funcdef>
    </funcprototype>
   </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="vc_desc_vscx">
  <title>Description</title>
  <para>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.
      </para>
  </refsect1>
  <refsect1 id="vc_attrs_vscx">
  <title>Attributes</title>
  <formalpara>
   <title>name = <link linkend="vc_type_SqlName">SqlName</link>
   </title>
    <para>A page level unique name identifying a control.</para>
  </formalpara>
  <formalpara>
    <title>annotation</title>
    <para>A human readable comment.</para>
  </formalpara>
  <formalpara>
   <title>initial-enable = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
   </title>
    <para>Determines  whether  a control is initially visible. True by default. Could be data-bound to an SQL expression.</para>
  </formalpara>
  <formalpara>
   <title>enabled = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
   </title>
    <para>Determines  whether  a control is visible. True by default. Could be data-bound to an SQL expression.</para>
  </formalpara>
  <formalpara>
   <title>instantiate = <link linkend="vc_type_CalculateableValue">CalculateableValue</link>
   </title>
    <para>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 &#39;on-init&#39; event handler of the control; other values are calculated before calling &#39;before-data-bind&#39; event handler.</para>
  </formalpara>
  <formalpara>
   <title>control-udt = <link linkend="vc_type_SqlName">SqlName</link>
   </title>
    <para>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 &#39;control-udt&#39; attribute should be equal to the name of the desired target UDT.</para>
  </formalpara>
  <formalpara>
    <title>xsd-stub-xhtml</title>
    <para>This attribute is for internal use only. It has no effect if added to the source VSPX file.</para>
  </formalpara>
  <formalpara>
    <title>width</title>
    <para>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.</para>
  </formalpara>
  <formalpara>
    <title>height</title>
    <para>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.</para>
  </formalpara>
  <formalpara>
    <title>url</title>
    <para>Reference to a VSPX page to be instantiated as a control.</para>
  </formalpara>
  <formalpara>
    <title>debug-srcfile</title>
    <para>URI of the source document where the tag comes from.</para>
  </formalpara>
  <formalpara>
    <title>debug-srcline</title>
    <para>Line number in the source document where the tag comes from.</para>
  </formalpara>
  <formalpara>
    <title>debug-log</title>
    <para>This defines what sort of data are saved to the debugging log.
</para>
  </formalpara>
  </refsect1>
  <refsect1 id="vc_udt_vscx">
  <title>Declaration of type vspx_vscx</title>
  <para>
</para>
  <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
</screen>
  </refsect1>
  <refsect1 id="vc_ex_vscx">
  <title>Examples</title>
   <example id="vc_ex_vscx__0">
    <title>
  Outer page, including a navigation bar via vscx__1.vspx
</title>
    <para>
&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;!--
 -  
 -  $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&#39;s page class will be instantiated twice as
as a child of outer page.

</para>
    <screen>
&lt;v:page name=&quot;outer_page&quot; xmlns:v=&quot;http://www.openlinksw.com/vspx/&quot;&gt;
  &lt;html&gt;
    &lt;body&gt;
      &lt;v:variable name=&quot;var1&quot; type=&quot;int&quot; default=&quot;0&quot; /&gt;
      &lt;h3&gt;Embeeding a page as a custom control&lt;/h3&gt;
      &lt;v:form type=&quot;simple&quot; name=&quot;f1&quot;&gt;
	&lt;div&gt;
	  &lt;div&gt;control1&lt;/div&gt;
	  &lt;v:vscx name=&quot;bar1&quot; url=&quot;vscx__1.vspx&quot;/&gt;
	&lt;/div&gt;
	&lt;div&gt;
	  &lt;div&gt;control2&lt;/div&gt;
	  &lt;v:vscx name=&quot;bar2&quot; url=&quot;vscx__1.vspx&quot;/&gt;
	&lt;/div&gt;
	&lt;div&gt;
	  &lt;v:text name=&quot;txt2&quot; /&gt;
	  &lt;v:button action=&quot;simple&quot; value=&quot;Outer&quot; name=&quot;b2&quot; /&gt;
	&lt;/div&gt;
      &lt;/v:form&gt;
    &lt;/body&gt;
  &lt;/html&gt;
&lt;/v:page&gt;
</screen>
   </example>
   <example id="vc_ex_vscx__1">
    <title>
  Simple navigation bar used as custom control
</title>
    <para>
&lt;?xml version=&quot;1.0&quot;?&gt;
&lt;!--
 -  
 -  $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.

</para>
    <screen>
&lt;v:page name=&quot;custom_bar&quot; xmlns:v=&quot;http://www.openlinksw.com/vspx/&quot;&gt;
  &lt;v:variable name=&quot;test&quot; type=&quot;int&quot; default=&quot;12&quot; /&gt;
  &lt;table border=&quot;1&quot; cellspacing=&quot;1&quot; cellpadding=&quot;0&quot;&gt;
    &lt;tr&gt;
      &lt;td&gt;
	&lt;v:url name=&quot;u1&quot; value=&quot;Home&quot; url=&quot;--http_path ()&quot; /&gt; |
      &lt;/td&gt;
      &lt;td&gt;
	&lt;v:url name=&quot;u2&quot; value=&quot;Settings&quot; url=&quot;--http_path ()||&#39;?settings&#39;&quot; /&gt; |
      &lt;/td&gt;
      &lt;td&gt;
	&lt;v:url name=&quot;u3&quot; value=&quot;Posts&quot; url=&quot;--http_path ()||&#39;?posts&#39;&quot; /&gt; |
      &lt;/td&gt;
      &lt;td&gt;
	&lt;v:url name=&quot;u4&quot; value=&quot;Maintenance&quot; url=&quot;--http_path ()||&#39;?maint&#39;&quot; /&gt;
      &lt;/td&gt;
    &lt;/tr&gt;
  &lt;/table&gt;
  &lt;div&gt;
    &lt;v:form type=&quot;simple&quot; name=&quot;f1&quot;&gt;
      &lt;v:text name=&quot;txt1&quot; /&gt;
      &lt;v:button name=&quot;b1&quot; action=&quot;simple&quot; value=&quot;Inner&quot;/&gt;
    &lt;/v:form&gt;
  &lt;/div&gt;
&lt;/v:page&gt;
</screen>
   </example>
  </refsect1>
</refentry>