complexType "lum_editButton"
Namespace:
Content:
complex, 8 attributes, 3 elements
Defined:
globally in lum_button.xsd, see XML source
Includes:
definitions of 7 attributes and 3 elements
Used:
XML Representation Summary
<...
   
interfaceId
 = 
xsd:string
   
isPrimary
 = 
xsd:boolean : "false"
   
keepParentActive
 = 
xsd:boolean : "false"
   
listControlId
 = 
xsd:string
   
openRuntimeInterfaceBehavior
 = 
("popup" | "replace" | "lightbox")
   
parameterId
 = 
xsd:string
   
sourceId
 = 
xsd:string
   
text
 = 
xsd:string : "STR_EDIT"
   
>
   
Content: 
</...>
Content Elements (3):
image (type xsd:string),
All Direct / Indirect Based Elements (1):
Known Usage Locations
Type Definition Detail
Type Derivation Tree
lum_control
  lum_sourceBoundControl (extension)
      lum_editButton (extension)
XML Source
<xsd:complexType name="lum_editButton">
<xsd:complexContent>
<xsd:extension base="lum_sourceBoundControl">
<xsd:sequence minOccurs="0">
<xsd:element default="lumis/portal/client/images/Edit.gif" minOccurs="0" name="image" type="xsd:string"/>
<xsd:element maxOccurs="1" minOccurs="0" name="rowAction" type="lum_rowAction">
<xsd:annotation>
<xsd:documentation>
Indicates that the button is going to be a row action. Row actions are those actions that performs some processing over the table items, such as delete and edit.
</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element maxOccurs="unbounded" minOccurs="0" name="onClick" type="onClientEvent"/>
</xsd:sequence>
<xsd:attribute default="STR_EDIT" name="text" type="xsd:string" use="optional"/>
<xsd:attribute name="interfaceId" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
By default the edit interface opened when you press this button will use the following rules in precedence order:
1)Interface Id explicitly in as an attribute
2)Interface (if exists) with id = "edit"+currentInterfaceId with first letter in upper case. e.g. if the current interface is administration, the interface calculated will be editAdministration
3)Interface (if exists) with id = "edit"

If none of these rules apply, the button control will remove itself from its parent.
If the destination interface has been placed within a page of the portal, this button will redirect to that page.
If the destination interface has not been placed in a page, the button will open a popup page with the given interface mounted run-time.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="keepParentActive" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
By default, a "keepParentActive" attribute with value "false" is used on the onClick event for opening the destination interface for this edit button.
By specifying this attribute on the edit button, it will be used when generating its onClick event.
<p>
For more information, see keepParentActive attribute on the onClick element.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:annotation>
<xsd:documentation>
<![CDATA[
By default no openRuntimeInterfaceBehavior on the onClick generated for the edit button.
If a value is specified in this attribute, it will be used on the onClick event for opening the destination interface for this edit button.
<p>
For more information, see openRuntimeInterfaceBehavior attribute on the onClick element.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="listControlId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Identifier of the list control that this button is associated to. If not specified the id of the first control of type lum_advancedTabularData, lum_details or lum_tabularData (in this order of preference) in the interface is used.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="parameterId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
By default the edit button passes the primary key value with a parameter name as the field id. If you want to change the name of the parameter that is being passed to the edit property page, set this value to the desired name.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute default="false" name="isPrimary" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates whether the button is a primary button. Primary buttons are emphasized over non-primary buttons.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
Attribute Detail (defined in this component only)
interfaceId
By default the edit interface opened when you press this button will use the following rules in precedence order: 1)Interface Id explicitly in as an attribute 2)Interface (if exists) with id = "edit"+currentInterfaceId with first letter in upper case. e.g. if the current interface is administration, the interface calculated will be editAdministration 3)Interface (if exists) with id = "edit" If none of these rules apply, the button control will remove itself from its parent. If the destination interface has been placed within a page of the portal, this button will redirect to that page. If the destination interface has not been placed in a page, the button will open a popup page with the given interface mounted run-time.
Type:
xsd:string
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="interfaceId" type="xsd:string" use="optional">
<xsd:annotation>
<xsd:documentation>
By default the edit interface opened when you press this button will use the following rules in precedence order:
1)Interface Id explicitly in as an attribute
2)Interface (if exists) with id = "edit"+currentInterfaceId with first letter in upper case. e.g. if the current interface is administration, the interface calculated will be editAdministration
3)Interface (if exists) with id = "edit"

If none of these rules apply, the button control will remove itself from its parent.
If the destination interface has been placed within a page of the portal, this button will redirect to that page.
If the destination interface has not been placed in a page, the button will open a popup page with the given interface mounted run-time.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

isPrimary
Indicates whether the button is a primary button. Primary buttons are emphasized over non-primary buttons.
Type:
xsd:boolean
Use:
optional
Default:
"false"
Defined:
locally, within this complexType
XML Source
<xsd:attribute default="false" name="isPrimary" type="xsd:boolean" use="optional">
<xsd:annotation>
<xsd:documentation>
Indicates whether the button is a primary button. Primary buttons are emphasized over non-primary buttons.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

keepParentActive
By default, a "keepParentActive" attribute with value "false" is used on the onClick event for opening the destination interface for this edit button. By specifying this attribute on the edit button, it will be used when generating its onClick event. <p> For more information, see keepParentActive attribute on the onClick element.
Type:
xsd:boolean
Use:
optional
Default:
"false"
Defined:
locally, within this complexType
XML Source
<xsd:attribute default="false" name="keepParentActive" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
By default, a "keepParentActive" attribute with value "false" is used on the onClick event for opening the destination interface for this edit button.
By specifying this attribute on the edit button, it will be used when generating its onClick event.
<p>
For more information, see keepParentActive attribute on the onClick element.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

listControlId
Identifier of the list control that this button is associated to. If not specified the id of the first control of type lum_advancedTabularData, lum_details or lum_tabularData (in this order of preference) in the interface is used.
Type:
xsd:string
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="listControlId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
Identifier of the list control that this button is associated to. If not specified the id of the first control of type lum_advancedTabularData, lum_details or lum_tabularData (in this order of preference) in the interface is used.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

openRuntimeInterfaceBehavior
By default no openRuntimeInterfaceBehavior on the onClick generated for the edit button. If a value is specified in this attribute, it will be used on the onClick event for opening the destination interface for this edit button. <p> For more information, see openRuntimeInterfaceBehavior attribute on the onClick element.
Type:
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="openRuntimeInterfaceBehavior" type="openRuntimeInterfaceBehavior">
<xsd:annotation>
<xsd:documentation>
<![CDATA[
By default no openRuntimeInterfaceBehavior on the onClick generated for the edit button.
If a value is specified in this attribute, it will be used on the onClick event for opening the destination interface for this edit button.
<p>
For more information, see openRuntimeInterfaceBehavior attribute on the onClick element.
]]>
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

parameterId
By default the edit button passes the primary key value with a parameter name as the field id. If you want to change the name of the parameter that is being passed to the edit property page, set this value to the desired name.
Type:
xsd:string
Use:
optional
Defined:
locally, within this complexType
XML Source
<xsd:attribute name="parameterId" type="xsd:string">
<xsd:annotation>
<xsd:documentation>
By default the edit button passes the primary key value with a parameter name as the field id. If you want to change the name of the parameter that is being passed to the edit property page, set this value to the desired name.
</xsd:documentation>
</xsd:annotation>
</xsd:attribute>

text
Type:
xsd:string
Use:
optional
Default:
"STR_EDIT"
Defined:
locally, within this complexType
XML Source
<xsd:attribute default="STR_EDIT" name="text" type="xsd:string" use="optional"/>
Content Element Detail
image
Type:
xsd:string, simple content
Default:
"lumis/portal/client/images/Edit.gif"
Defined:
locally, within this complexType
XML Source
<xsd:element default="lumis/portal/client/images/Edit.gif" minOccurs="0" name="image" type="xsd:string"/>

onClick
Type:
onClientEvent, complex content
Defined:
locally, within this complexType
XML Source
<xsd:element maxOccurs="unbounded" minOccurs="0" name="onClick" type="onClientEvent"/>

rowAction
Indicates that the button is going to be a row action. Row actions are those actions that performs some processing over the table items, such as delete and edit.
Type:
lum_rowAction, empty content
Defined:
locally, within this complexType
XML Source
<xsd:element maxOccurs="1" minOccurs="0" name="rowAction" type="lum_rowAction">
<xsd:annotation>
<xsd:documentation>
Indicates that the button is going to be a row action. Row actions are those actions that performs some processing over the table items, such as delete and edit.
</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.