complexType "onClientEvent"
Namespace:
Content:
complex, 7 attributes, 10 elements
Defined:
Includes:
definitions of 7 attributes and 10 elements
Used:
XML Representation Summary
<...
   
keepParentActive
 = 
xsd:boolean : "true"
   
openRuntimeInterfaceBehavior
 = 
openRuntimeInterfaceBehavior
   
popupRuntimeInterfaceIfNoLinkFound
 = 
xsd:boolean
   
popupSize
 = 
popupSize : "normal"
   
processActionId
 = 
xsd:string
   
renderActionId
 = 
xsd:string
   
type
 = 
onClientEventType
   
>
   
Content: 
</...>
Content Elements (10):
addParameters (type addControlParameters),
clientSideUpdateControlId (type xsd:string),
hyperLink (type hyperLink),
interfaceId (type xsd:string),
method (type actionMethod),
pageId (type xsd:string),
script (type xsd:string),
target (type linkTarget),
url (type xsd:string),
validators (type controlClientEventValidators)
All Direct / Indirect Based Elements (1):
Known Usage Locations
XML Source
<xsd:complexType name="onClientEvent">
<xsd:all maxOccurs="1">
<xsd:element minOccurs="0" name="validators" type="controlClientEventValidators">
<xsd:annotation>
<xsd:documentation>
Before executing the client side event these validators may be tested.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="addParameters" type="addControlParameters"/>
<xsd:element minOccurs="0" name="pageId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "popupRunTimeInterface". If not specified the current page is used as default. A common value used here is "LumisBlankPage".
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="interfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "popupRunTimeInterface". If specified, the popup window will instantiate this interface runtime and render it. The interfaceId may be relative to the serviceId or a complete id (i.e. serviceid.interfaceid). Interface ids may no contain the dot(.) character.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="method" type="actionMethod">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "renderAction". Specifies how the request will be sent to the server. Via "post" or "get".
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="url" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". Specifies an absolute or relative url.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="hyperLink" type="hyperLink">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". Requests the portal for a url given an interfaceId.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="script" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "script". The entire script that must be rendered client side.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="target" type="linkTarget">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". The target of the link by default is the current window.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element minOccurs="0" name="clientSideUpdateControlId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Applies only when the type is renderAction. Specifies what control must be updated. No other control is changed.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:all>
<xsd:attribute name="type" type="onClientEventType"/>
<xsd:attribute name="processActionId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "processAction". Specifies the identifier of the process action that needs to be executed.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="renderActionId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "renderAction". Specifies the identifier of the render action that needs to be executed.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="popupRuntimeInterfaceIfNoLinkFound" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". If the link is not found the event is processed exactly as type "popupRunTimeInterface".
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="openRuntimeInterfaceBehavior" type="openRuntimeInterfaceBehavior">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
Used when the event type is "popupRunTimeInterface". Specifies the open runtime interface behavior.
<p>
The possible values are:
<ul>
<li><b>popup</b>: When this open behavior is set, the runtime interface will be shown in a browser popup. This choice keeps the parent interface active.</li>
<li><b>replace</b>: When this open behavior is set, the runtime interface will replace the parent interface with the runtime one. This choice does not keep the parent interface active.</li>
<li><b>lightbox</b>: When this open behavior is set, the runtime interface will be shown in a lightbox style element. This choice keeps the parent interface active.</li>
</ul>
</p>
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="true" name="keepParentActive" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
Used when the event type is "popupRunTimeInterface". Specifies whether the parent interface must be kept active. If the attribute "openRuntimeInterfaceBehavior" is provided,
this configuration does nothing, since the open runtime interface behavior is forced. When the attribute "openRuntimeInterfaceBehavior" is not set, then this configuration is
a hint to the portal to calculate the correct open interface behavior. If this configuration is not set, it is considered to be "true".
<p>
If the portal is going to calculate the correct behavior, it will read the configuration from the applied themes.<br />
The applied themes to be considered are the nearest themes applied from the current element to the portal's root channel.<br />
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="normal" name="popupSize" type="popupSize">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
Used when the event type is "popupRunTimeInterface". Specifies the size of the popup.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
Attribute Detail
keepParentActive
Used when the event type is "popupRunTimeInterface". Specifies whether the parent interface must be kept active. If the attribute "openRuntimeInterfaceBehavior" is provided, this configuration does nothing, since the open runtime interface behavior is forced. When the attribute "openRuntimeInterfaceBehavior" is not set, then this configuration is a hint to the portal to calculate the correct open interface behavior. If this configuration is not set, it is considered to be "true". <p> If the portal is going to calculate the correct behavior, it will read the configuration from the applied themes.<br /> The applied themes to be considered are the nearest themes applied from the current element to the portal's root channel.<br />
Type:
xsd:boolean
Use:
optional
Default:
"true"
Defined:
locally, within this complexType
XML Source
<xsd:attribute default="true" name="keepParentActive" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
Used when the event type is "popupRunTimeInterface". Specifies whether the parent interface must be kept active. If the attribute "openRuntimeInterfaceBehavior" is provided,
this configuration does nothing, since the open runtime interface behavior is forced. When the attribute "openRuntimeInterfaceBehavior" is not set, then this configuration is
a hint to the portal to calculate the correct open interface behavior. If this configuration is not set, it is considered to be "true".
<p>
If the portal is going to calculate the correct behavior, it will read the configuration from the applied themes.<br />
The applied themes to be considered are the nearest themes applied from the current element to the portal's root channel.<br />
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

openRuntimeInterfaceBehavior
Used when the event type is "popupRunTimeInterface". Specifies the open runtime interface behavior. <p> The possible values are: <ul> <li><b>popup</b>: When this open behavior is set, the runtime interface will be shown in a browser popup. This choice keeps the parent interface active.</li> <li><b>replace</b>: When this open behavior is set, the runtime interface will replace the parent interface with the runtime one. This choice does not keep the parent interface active.</li> <li><b>lightbox</b>: When this open behavior is set, the runtime interface will be shown in a lightbox style element. This choice keeps the parent interface active.</li> </ul> </p>
Type:
openRuntimeInterfaceBehavior
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="openRuntimeInterfaceBehavior" type="openRuntimeInterfaceBehavior">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
Used when the event type is "popupRunTimeInterface". Specifies the open runtime interface behavior.
<p>
The possible values are:
<ul>
<li><b>popup</b>: When this open behavior is set, the runtime interface will be shown in a browser popup. This choice keeps the parent interface active.</li>
<li><b>replace</b>: When this open behavior is set, the runtime interface will replace the parent interface with the runtime one. This choice does not keep the parent interface active.</li>
<li><b>lightbox</b>: When this open behavior is set, the runtime interface will be shown in a lightbox style element. This choice keeps the parent interface active.</li>
</ul>
</p>
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

popupRuntimeInterfaceIfNoLinkFound
Used when the event type is "link". If the link is not found the event is processed exactly as type "popupRunTimeInterface".
Type:
xsd:boolean
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="popupRuntimeInterfaceIfNoLinkFound" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". If the link is not found the event is processed exactly as type "popupRunTimeInterface".
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

popupSize
Used when the event type is "popupRunTimeInterface". Specifies the size of the popup.
Type:
popupSize
Use:
optional
Default:
"normal"
Defined:
locally, within this complexType
XML Source
<xsd:attribute default="normal" name="popupSize" type="popupSize">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
Used when the event type is "popupRunTimeInterface". Specifies the size of the popup.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

processActionId
Used when the event type is "processAction". Specifies the identifier of the process action that needs to be executed.
Type:
xsd:string
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="processActionId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "processAction". Specifies the identifier of the process action that needs to be executed.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

renderActionId
Used when the event type is "renderAction". Specifies the identifier of the render action that needs to be executed.
Type:
xsd:string
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="renderActionId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "renderAction". Specifies the identifier of the render action that needs to be executed.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

type
Type:
onClientEventType
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="type" type="onClientEventType"/>
Content Element Detail
addParameters
Type:
addControlParameters, ??? content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="addParameters" type="addControlParameters"/>

clientSideUpdateControlId
Applies only when the type is renderAction. Specifies what control must be updated. No other control is changed.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="clientSideUpdateControlId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Applies only when the type is renderAction. Specifies what control must be updated. No other control is changed.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

hyperLink
Used when the event type is "link". Requests the portal for a url given an interfaceId.
Type:
hyperLink, ??? content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="hyperLink" type="hyperLink">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". Requests the portal for a url given an interfaceId.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

interfaceId
Used when the event type is "popupRunTimeInterface". If specified, the popup window will instantiate this interface runtime and render it. The interfaceId may be relative to the serviceId or a complete id (i.e. serviceid.interfaceid). Interface ids may no contain the dot(.) character.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="interfaceId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "popupRunTimeInterface". If specified, the popup window will instantiate this interface runtime and render it. The interfaceId may be relative to the serviceId or a complete id (i.e. serviceid.interfaceid). Interface ids may no contain the dot(.) character.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

method
Used when the event type is "renderAction". Specifies how the request will be sent to the server. Via "post" or "get".
Type:
actionMethod, ??? content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="method" type="actionMethod">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "renderAction". Specifies how the request will be sent to the server. Via "post" or "get".
</xsd:documentation>
</xsd:annotation>
</xsd:element>

pageId
Used when the event type is "popupRunTimeInterface". If not specified the current page is used as default. A common value used here is "LumisBlankPage".
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="pageId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "popupRunTimeInterface". If not specified the current page is used as default. A common value used here is "LumisBlankPage".
</xsd:documentation>
</xsd:annotation>
</xsd:element>

script
Used when the event type is "script". The entire script that must be rendered client side.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="script" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "script". The entire script that must be rendered client side.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

target
Used when the event type is "link". The target of the link by default is the current window.
Type:
linkTarget, ??? content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="target" type="linkTarget">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". The target of the link by default is the current window.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

url
Used when the event type is "link". Specifies an absolute or relative url.
Type:
xsd:string, simple content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="url" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Used when the event type is "link". Specifies an absolute or relative url.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

validators
Before executing the client side event these validators may be tested.
Type:
controlClientEventValidators, ??? content
Defined:
locally, within this complexType
XML Source
<xsd:element minOccurs="0" name="validators" type="controlClientEventValidators">
<xsd:annotation>
<xsd:documentation>
Before executing the client side event these validators may be tested.
</xsd:documentation>
</xsd:annotation>
</xsd:element>

XML Schema documentation generated with DocFlex/XML (Kit) v1.6.2
DocFlex/XML is a powerful template-driven documentation and report generator from any data stored in XML files. Based on an innovative technology developed by FILIGRIS WORKS, this new tool offers virtuoso data querying and formatting capabilities not found in anything else!
Need to convert your XML data into a clear nice-looking documentation or reports? Web-ready hypertext HTML or printable MS Word / OpenOffice.org friendly RTF? DocFlex/XML may be a cheap, quick and effective solution exactly for this task!
Have questions? Not sure how to use it? Just send us e-mail to contact@filigris.com and we are always happy to help you! See also our services at www.filigris.com

Lumisportal  14.0.0.210430 - Copyright © 2006–2021 Lumis EIP Tecnologia da Informação LTDA. All Rights Reserved.