DecSoft App Builder

Figure description

The Figure control allows to show an image into the app views, app dialogs or app frames. We can change the image that is show at runtime by using the control Url property. The different between this control and the Image control is that the Figure control show an optional text below the image, by setting their Caption property.

There is a Figure sample app included with the installation of DecSoft App Builder. Take a look to see this control in action!

Figure CSS rules

This control has a default style, and, some control JavaScript properties (see below), can also changes the control style, not to mention the Classes property, that you can use to establish one or more CSS classes to be applied to the control.

In addition to that style, you can also set custom CSS rules for the control by using the IDE controls style inspector. If this is not enough, you can include any number of CSS stylesheets in the app by using the app files manager.

If you want to use CSS stylesheets, you need to know how to refer to the control, so take a look at the Runtime selectors help topic.

Figure at designtime

The Figure control put at your disposition the below designtime properties or variables. Designtime means here that these properties are only available in designtime and not in runtime.

Figure at runtime

The Figure control put at your disposition the below runtime properties or variables. You can set almost all these variables in designtime, and, they are also available to be use when the app is running. Note that we named here these variables in a capitalized way, because is like you can see it in the designtime control's inspector, however, at runtime we use the lower camel case way.

Figure events

The Figure control put at your disposition the below events handlers:

Figure designtime properties

Figure Top property

Designtime. Integer variable. The Top property stores the top position of the control in pixels. The pixels are relative to the app view, dialog or frame, and, is used "as is" if the app have the "Scale" app option is set to "false". Remember that this control property is only for designtime and is not available in runtime.

Figure Left property

Designtime. Integer variable. The Left property stores the left position of the control in pixels. The pixels are relative to the app view, dialog or frame, and, is used "as is" if the app have the "Scale" app option is set to "false". Remember that this control property is only for designtime and is not available in runtime.

Figure Width property

Designtime. Integer variable. The Width property stores the width of the control in pixels. The pixels are relative to the app view, dialog or frame, and, is used "as is" if the app have the "Scale" app option is set to "false". Remember that this control property is only for designtime and is not available in runtime.

Figure Height property

Designtime. Integer variable. The Height property stores the height of the control in pixels. The pixels are relative to the app view, dialog or frame, and, is used "as is" if the app have the "Scale" app option is set to "false". Remember that this control property is only for designtime and is not available in runtime.

Figure Locked property

Designtime. Boolean variable. The Locked property determines if the control can be moved or resized in app view designer or not. Set a "false" value mean the control can be moved and resized. Set a "true" value (by default) mean the control cannot be moved nor resized. Remember that this control property is only for designtime and is not available in runtime.

Figure runtime properties

Figure Name property

Runtime. String variable. The Name control property stores the name of the Figure control as you set in designtime. The Name property value must be unique for the same app view, dialog or frame, that is, it's possible to have more than one "figure1" in the app, if that controls resides in different app views, dialogs or frames. Note that you must consider this variable as read only: change the name of a control in runtime can cause unexpected results.

Figure Event property

Runtime. Mixed variable. The Event control property stores the "event" variable received in all the control events. This variable can contain the target (HTML element of the control) that fire the event and more useful stuff.

Figure Url property

Runtime. String variable. The Url control property stores the URL of the image that is show in the control. We can set this variable in runtime to change the showing image.

Figure Caption property

Runtime. String variable. The Caption control property stores the text that is shown below the Figure control image.

Figure ImageFit property

Runtime. String variable. The ImageFit determines how the image is show even if the app "Scale" option is set to "true". You can use one of the available "app.imageFit.*" constants to set this property, which is "cover" by default.

Figure Description property

Runtime. String variable. The Description control property stores a descriptive text for the image which is shown, for example, in case that the image cannot be show due to some error.

Figure Title property

Runtime. String variable. The Title control property stores some small but descriptive text, mainly to be used to be show that text when the user place the mouse cursor into the control.

Figure Classes property

Runtime. String variable. The Classes control property stores one or more additionals CSS classes (space separated) to be applied to the control.

Figure Hidden property

Runtime. Boolean variable. The Hidden control property determines if the control appear visible to the user or not. Set to "true" to hide the control, or to "false" to show the control (by default).

Figure events

Figure Load event

The Load event handler is fired when the image has been loaded and show to the user. See also the available events variables.

Figure Error event

The Error event handler is fired when image cannot be loaded and show due to an error. See also the available events variables.

Figure Click event

The Click event handler is fired when the user click or tap into the Figure control. See also the available events variables.

Figure DblClick event

The DblClick (Double Click) event handler is fired when the user double click or double tap into the Figure control. See also the available events variables.

Figure MouseUp event

The MouseUp event handler is fired when the user up the mouse into the Figure control. See also the available events variables.

Figure MouseDown event

The MouseDown event handler is fired when the user down the mouse into the Figure control. See also the available events variables.

Figure MouseMove event

The MouseMove event handler is fired when the user move the mouse into the Figure control. See also the available events variables.

Figure MouseEnter event

The MouseEnter event handler is fired when the user enter the mouse into the Figure control. See also the available events variables.

Figure MouseLeave event

The MouseLeave event handler is fired when the user leave the mouse from the Figure control. See also the available events variables.

Figure ContextMenu event

The ContextMenu event handler is fired when the browser must shown the context menu of the the Figure control, which occur when the user click with the right mouse button into the Figure control. See also the available events variables.

Figure events variables

The below JavaScript variables are available in all the referred Figure control events handlers:

Name Type Description
event Mixed This variable is received in almost all control events. You can use this variable to stop the propagation of the event, to access the HTML element who fire the event and more.
self Object Stores the control object. This is a shortcut to the control variable, and it's available since we are talking about specific control events.
view Object

Stores the current app view or dialog. This variable allow us to access to that view or dialog properties and methods and also their controls properties and methods. For example, you can access to a control properties using the variable "view.yourControlName", suposing the control is named "yourControlName".

views Object Stores all the loaded app views. Note that loaded views mean that the app views has been previously show to the user. It's possible to access to the app view controls properties like "views.view1.yourControlName", suposing the view is named "view1" and the control is named "yourControlName". In the same way we can access to other controls of the view and to other loaded views and their controls.
frames Object Stores all the app frames. You can use this variable to access to all the app frames and their controls.
dialogs Object Stores all the app dialogs. You can use this variable to access to all the app dialogs and their controls.
app Object Stores all the app properties and methods. You can use this variable to access to all the app properties and app methods.