Collapsible: Difference between revisions

From NSB App Studio
Jump to navigation Jump to search
Created page with "File:Collapsible.png ''On the left, without the panel. On the right, showing the panel.'' == Description == The Collapsible control displays HTML or a Form in a panel t..."
 
No edit summary
Line 1: Line 1:
[[File:Collapsible.png]]
[[File:Collapsible.png]]


''On the left, without the panel. On the right, showing the panel.''
''On the top, a closed Collapsible with a black them. Underneath, an open Collapsible with a white theme.''


== Description ==
== Description ==

Revision as of 13:52, 12 April 2015

On the top, a closed Collapsible with a black them. Underneath, an open Collapsible with a white theme.

Description

The Collapsible control displays HTML or a Form in a panel that floats on top of the current form. It can be animated to appear from the left or right.

To add a Collapsible to your app, choose the Collapsible icon in the Toolbar, then position it on the Design Screen. Use the Property Editor to set the properties you need.

If a form is opened in a Panel, NSBCurrentForm is set to the new form and the form's onshow() function is called. When the Panel is closed, the onhide() function is called and NSBCurrentForm is set to the previous form. The size of the form is adjusted to be equal the size of the panel.

Properties

Standard properties are supported, plus:

animate Sets whether the panel will animate when opening and closing. If set to false, the panel will just appear and disappear without animation. This is recommended for fastest performance. Design time.
close() Closes panel. Runtime.
dismissable Sets whether the panel can be closed by clicking outside onto the page. Design time.
display The relationship of the panel to the page contents. Default is 'reveal: the panel will sit under the page and reveal as the page slides away. 'overlay" for the panel to appear on top of the page contents. "push" animates both the panel and page at the same time. Design time.
open([form]) Opens form in the panel. If form is blank, uses contents of text property. Runtime.
positionFixed Sets whether the panel has fixed positioning so the contents are in view even if the page is scrolled down. This also allows the page to scroll while the panel stays fixed. Design time.
previousForm A reference to the form which will be returned to when the panel is closed. Runtime.
text The text to display on the form. Can be HTML. Leave blank if using Form1.open(Form2). Design time.

Events

Example

Open Form2 in a Panel

  Panel2.open(Form2)

See above for output.