416.467.9100 | Dundas Data Visualization | Login
Welcome Guest
This is the support page for the legacy Dundas Dashboard application. For assistance with the current Dundas BI application please click here.
Dashboard v5.0

This site makes extensive use of JavaScript.

Please enable JavaScript in your web browser and reload the page before proceeding.

DashboardElement Class

Hide navigation
RSS
Modified on Fri, 22 Nov 2013 05:44 PM

The base class for any element which is to appear on a dashboard.

DashboardElement is a DashboardObject.

Properties

Common

ImageImageProperty Name [Script Name]TypeDescription
[DerivedFriendlyName]stringGets the name based on FriendlyName if set, otherwise Name.
[FriendlyName]stringThe friendly name of the control which will appear to viewers and should be easily identifiable for them.
ImageHit Test Visible [IsHitTestVisible]boolIndicates whether this element can be interacted with.
[Name]stringThe name of the control which can be used to reference it with scripting.
Tooltip [ToolTip]stringThe tooltip typically shows up when the user hovers over the element with their mouse.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageMouse Cursor [Cursor]DashboardCursorThe mouse cursor that displays when the viewer puts their mouse overtop of this element.
ImageImageOpacity [Opacity]doubleThe opacity of the control.
ImageVisibility [Visibility]VisibilityIndicates whether this control is visible or not. If it is collapsed, it will not be visible.
ImageImageVisual Effect [VisualEffect]DashboardEffectThe visual effect applied to this element.

Layout

ImageImageProperty Name [Script Name]TypeDescription
[BottomGuidelineName]stringThe name of the bottom guideline.
Height [Height]doubleThe height of the control.
Left [Left]doubleThe left is how far from the left side the control resides.
[LeftGuidelineName]stringThe name of the left guideline.
ImageMargin [Margin]ThicknessThe margin around the outside of the control in pixels.
ImageBottom [Bottom]doubleThe bottom margin thickness, in pixels.
ImageLeft [Left]doubleThe left margin thickness, in pixels.
ImageRight [Right]doubleThe right margin thickness, in pixels.
ImageTop [Top]doubleThe top margin thickness, in pixels.
[RightGuidelineName]stringThe name of the right guideline.
Top [Top]doubleThe top is how far from the top the control resides.
[TopGuidelineName]stringThe name of the top guideline.
Width [Width]doubleThe width of the control.

Other

ImageImageProperty Name [Script Name]TypeDescription
ImageAccelerator Key [AcceleratorKey]stringThis is the accelerator key for accessibility.
ImageAccess Key [AccessKey]stringThis is the access key for accessibility.
Help Text [HelpText]stringThis is the help text for accessibility.
[Tag]objectUsed to store an arbitrary object in script.

Interactions

Click

The Click interaction lets you respond to mouse clicks on the control.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

Context Click

The Context Click interaction lets you respond when the right mouse button is released.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

This interaction is also used to call up the context menu, so setting the Handled property of e to true prevents the context menu from appearing, otherwise the commands visible in the context menu can be customized using the ContextCommands property of e.

Hover

The Hover interaction lets you respond to the user “hovering” their mouse over the control.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

Mouse Enter

The Mouse Enter interaction lets you respond to the user moving the mouse into the control's area.

ImageThis is an Advanced property.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

Mouse Leave

The Mouse Leave interaction lets you respond to the user moving the mouse out of the control's area.

ImageThis is an Advanced property.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

Note: The Mouse Leave event occurs whenever the mouse is no longer directly over the control. For example, if you displayed a message (via the services.ShowMessage method) that appeared under the mouse, the Mouse Leave event would occur even though the mouse hasn't moved.

Mouse Move

The Mouse Move interaction lets you respond to mouse movements in the control's area.

ImageThis is an Advanced property.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

Mouse Right Down

The Mouse Right Button Down interaction lets you respond when the right mouse button is pressed on the control.

ImageThis is an Advanced property.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

Mouse Up

The Mouse Up interaction lets you respond to when the mouse button is released in the control's area.

ImageThis is an Advanced property.

Arguments:


If this is a data control, the VisualElementArgs property of e may contain an element contained within this one that was clicked. Please refer to the Interactions reference provided by the control's documentation.

Related topics


About Dundas | Contact Us Follow us on Twitter! | Privacy Statement | Report Site Issues

Copyright © 2009-2014 Dundas Data Visualization, Inc.