complexType "dat:ButtonBarOptions"
Namespace:
http://labkey.org/data/xml
Content:
complex, 3 attributes, 3 elements
Defined:
globally in tableInfo.xsd, see XML source
Includes:
definitions of 3 attributes and 3 elements
Used:
at 1 location
XML Representation Summary
<...
    alwaysShowRecordSelectors
 = 
 xs:boolean
    includeStandardButtons
 = 
 xs:boolean
    position
 = 
 ("top" | "bottom" | "none" | "both")
    >
   
Content: 
 dat:includeScript*, dat:onRender?, dat:item*
</...>
Content Model Elements (3):
dat:includeScript (in dat:buttonBarOptions),
dat:item (in dat:buttonBarOptions),
dat:onRender (in dat:buttonBarOptions)
All Direct / Indirect Based Elements (1):
dat:buttonBarOptions (type dat:ButtonBarOptions)
Known Usage Locations
Annotation
Supported for SQL metadata
XML Source (see within schema source)
<xs:complexType name="ButtonBarOptions">
<xs:annotation>
<xs:documentation>Supported for SQL metadata</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element maxOccurs="unbounded" minOccurs="0" name="includeScript" type="xs:string">
<xs:annotation>
<xs:documentation>
Path to a client dependency that should be included as part of rendering this button bar.
Should start with slash and not include the context path. This can be an individual
JavaScript or CSS file, or it can be the name of a client dependency library that's been provided
by a module, such as "Ext4" or "clientapi".
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="1" minOccurs="0" name="onRender" type="xs:string">
<xs:annotation>
<xs:documentation>
Name of a JavaScript function to be invoked when the button bar is rendered.
Typically the function itself is defined in a client dependency pointed at by the includeScript
tag. The function will be passed one argument,
the LABKEY.DataRegion object for the grid attached to the button bar.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element maxOccurs="unbounded" minOccurs="0" name="item" type="dat:ButtonBarItem">
<xs:annotation>
<xs:documentation>The buttons to be added to the bar.</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="position" type="dat:PositionTypeEnum">
<xs:annotation>
<xs:documentation>
Where to render the button bar relative to the grid.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="includeStandardButtons" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, all of the default buttons will be included. If not, only
the buttons defined in the XML metadata will be shown.
</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="alwaysShowRecordSelectors" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, record selectors will always be shown, instead of calculating based on the available buttons.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
Attribute Detail
alwaysShowRecordSelectors
Type:
xs:boolean, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarOptions complexType
If true, record selectors will always be shown, instead of calculating based on the available buttons.
XML Source (see within schema source)
<xs:attribute name="alwaysShowRecordSelectors" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, record selectors will always be shown, instead of calculating based on the available buttons.
</xs:documentation>
</xs:annotation>
</xs:attribute>
includeStandardButtons
Type:
xs:boolean, predefined
Use:
optional
Defined:
locally, within (this) dat:ButtonBarOptions complexType
If true, all of the default buttons will be included. If not, only the buttons defined in the XML metadata will be shown.
XML Source (see within schema source)
<xs:attribute name="includeStandardButtons" type="xs:boolean">
<xs:annotation>
<xs:documentation>
If true, all of the default buttons will be included. If not, only
the buttons defined in the XML metadata will be shown.
</xs:documentation>
</xs:annotation>
</xs:attribute>
position
Type:
dat:PositionTypeEnum
Use:
optional
Defined:
locally, within (this) dat:ButtonBarOptions complexType
Where to render the button bar relative to the grid.
XML Source (see within schema source)
<xs:attribute name="position" type="dat:PositionTypeEnum">
<xs:annotation>
<xs:documentation>
Where to render the button bar relative to the grid.
</xs:documentation>
</xs:annotation>
</xs:attribute>
Content Element Detail
dat:includeScript
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:ButtonBarOptions complexType
Path to a client dependency that should be included as part of rendering this button bar. Should start with slash and not include the context path. This can be an individual JavaScript or CSS file, or it can be the name of a client dependency library that's been provided by a module, such as "Ext4" or "clientapi".
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="includeScript" type="xs:string">
<xs:annotation>
<xs:documentation>
Path to a client dependency that should be included as part of rendering this button bar.
Should start with slash and not include the context path. This can be an individual
JavaScript or CSS file, or it can be the name of a client dependency library that's been provided
by a module, such as "Ext4" or "clientapi".
</xs:documentation>
</xs:annotation>
</xs:element>
dat:item
Type:
dat:ButtonBarItem, complex content
Defined:
locally, within (this) dat:ButtonBarOptions complexType
The buttons to be added to the bar.
XML Source (see within schema source)
<xs:element maxOccurs="unbounded" minOccurs="0" name="item" type="dat:ButtonBarItem">
<xs:annotation>
<xs:documentation>The buttons to be added to the bar.</xs:documentation>
</xs:annotation>
</xs:element>
dat:onRender
Type:
xs:string, predefined, simple content
Defined:
locally, within (this) dat:ButtonBarOptions complexType
Name of a JavaScript function to be invoked when the button bar is rendered. Typically the function itself is defined in a client dependency pointed at by the includeScript tag. The function will be passed one argument, the LABKEY.DataRegion object for the grid attached to the button bar.
XML Source (see within schema source)
<xs:element maxOccurs="1" minOccurs="0" name="onRender" type="xs:string">
<xs:annotation>
<xs:documentation>
Name of a JavaScript function to be invoked when the button bar is rendered.
Typically the function itself is defined in a client dependency pointed at by the includeScript
tag. The function will be passed one argument,
the LABKEY.DataRegion object for the grid attached to the button bar.
</xs:documentation>
</xs:annotation>
</xs:element>
This XML schema documentation has been generated with DocFlex/XML RE 1.7.2 using DocFlex/XML XSDDoc 2.1.0 template set.
DocFlex/XML RE is a reduced edition of DocFlex/XML, which is a tool for programming and running highly sophisticated documentation and reports generators by the data obtained from any kind of XML files. The actual doc-generators are implemented in the form of special templates that are designed visually using a high quality Template Designer GUI basing on the XML schema (or DTD) files describing the data source XML.
DocFlex/XML XSDDoc is a commercial template application of DocFlex/XML that implements a high-end XML Schema documentation generator with simultaneous support of framed multi-file HTML, single-file HTML and RTF output formats. (More formats are planned in the future).
A commercial license for "DocFlex/XML XSDDoc" will allow you:
  • To configure the generated documentation so much as you want. Thanks to our template technology, it was possible to support more than 300 template parameters (working the same as "options" of an ordinary doc-gen), which will give you an unprecedented control over the generated content!
  • To use certain features disabled in the free mode (such as the full documenting of substitution groups).
  • To enable/disable documenting of the initial, imported, included and redefined XML schemas selectively.
  • To document local element components both globally and locally (similar to attributes).
  • To enable/disable reproducing of namespace prefixes.
  • To format your annotations with XHTML tags and reproduce that formatting both in HTML and RTF output.
  • To insert images in your annotations using XHTML <img> tags (supported both in HTML and RTF output).
  • To use PlainDoc.tpl main template to generate all the XML schema documentation in the form of a single HTML file.
  • To use the same template to generate the incredible quality RTF documentation.
  • To document only selected XML schema components specified by name.
  • To remove this very advertisement text
Once having only such a license, you will be able to run the fully-featured XML schema documentation generator both with DocFlex/XML SDK and with DocFlex/XML RE, which is a reduced free edition containing only the template interpretor / output generator. No other licenses will be required!
But this is not all. In addition to it, a commercial license for DocFlex/XML SDK will allow you to modify the XSDDoc templates themselves as much as you want. You will be able to achieve whatever was impossible to do with the template parameters only. And, of course, you could develop any template applications by your own!
Please note: By purchasing a license for this software, you not only acquire a useful tool, you will also make an important investment in its future development, the result of which you could enjoy later by yourself. Every single your purchase matters and makes a difference for us!
To buy a license, please follow this link: http://www.filigris.com/shop/