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.

Frame - Properties

Hide navigation
RSS
Modified on Fri, 22 Nov 2013 01:57 PM Categorized as General Controls
Click to return to: Documentation | Designing Dashboards | General Controls | Frame

The Frame control.

The Frame control.


Overview

This article describes the properties of the Dundas Dashboard Frame control.

Property attributes

Each property of the control may have attributes as follows:

Property attribute
ImageThis is an Advanced property.
ImageThis is a property that can be saved into a Style Resource.

Also, note that a property appearing without a Property Name is accessible via scripting only.


Properties

Common

ImageImageProperty Name [Script Name]TypeDescription
[DerivedFriendlyName]stringGets the name based on FriendlyName if set, otherwise Name.
ImageEnabled [IsEnabled]boolIndicates whether this control can be interacted with. Some controls have a different appearance when not enabled.
Friendly 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 [Name]stringThe name of the control which can be used to reference it with scripting.
Title Text [TitleText]stringThe text that appears in the title bar of the frame.
Tooltip [ToolTip]stringThe tooltip typically shows up when the user hovers over the element with their mouse.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageBackground [Background]DashboardBrushThe background brush of the control.
ImageBorder Brush [BorderBrush]DashboardBrushThe border of the control.
ImageBorder Thickness [BorderThickness]ThicknessThe thickness (in pixels) of the border.
ImageCorner Radius [CornerRadius]CornerRadiusControls the corner radius for the border of the entire control.
ImageFrame Visual Effect [FrameVisualEffect]DashboardEffectThe visual effect applied to this frame.
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.
Style [Not_accessible_in_script_editor] The style to use on this dashboard object.
ImageText Visual Effect [TextVisualEffect]DashboardEffectThe visual effect applied to the text of the frame.
ImageTitle Background [TitleBackground]DashboardBrushThe brush used to define the background of the text area.
ImageTitle Border [TitleBorderBrush]DashboardBrushThe brush that defines the border color(s) of the title bar.
ImageTitle Border Thickness [TitleBorderThickness]ThicknessThe thickness of the border around the title bar.
ImageTitle Visual Effect [TitleVisualEffect]DashboardEffectThe visual effect applied to this title area.
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.
ImageBottom Pin [BottomPin]boolIndicates whether the bottom pin is enabled or not.
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.
ImageLeft Pin [LeftPin]boolIndicates whether the left pin is enabled or not.
ImageMargin [Margin]ThicknessThe margin around the outside of the control in pixels.
ImageImagePadding [Padding]ThicknessThe padding around the inside of the control in pixels.
[RightGuidelineName]stringThe name of the right guideline.
ImageRight Pin [RightPin]boolIndicates whether the right pin is enabled or not.
ImageImageTitle Corner Radius [TitleCornerRadius]CornerRadiusThe corner radius of the title bar.
ImageTitle Docking [TitleDocking]FrameTitleDockingThe position of the title bar.
ImageTitle Height [TitleAreaHeight]doubleDetermines the thickness of the title bar
ImageTitle Padding [TitlePadding]ThicknessThe padding in the text that appears on the title bar.
Top [Top]doubleThe top is how far from the top the control resides.
[TopGuidelineName]stringThe name of the top guideline.
ImageTop Pin [TopPin]boolIndicates whether the top pin is enabled or not.
Width [Width]doubleThe width of the control.

Text

ImageImageProperty Name [Script Name]TypeDescription
ImageImageCustom Font [CustomFont]stringA comma-separated list of font names to use when the value of Font Family is set to <Custom>.
ImageFont Brush [Foreground]DashboardBrushThe brush used to paint text.
ImageFont Family [FontFamily]DashboardFontFamilyThe name of the font used for text.
ImageFont Size [FontSize]doubleThe size of the font (in pixels) used for text.
ImageFont Style [FontStyle]DashboardFontStyleThe style of the font used for text.
ImageFont Weight [FontWeight]DashboardFontWeightThe weight or thickness of the font used for text.
ImageTitle Alignment [TitleAlignment]TextAlignmentThe alignment of the text that appears in the title bar. Note: Justify is not supported in this 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.
ImageTab Index [TabIndex]intThe index that this item is in the tab order.
ImageTab Navigation [TabNavigation]KeyboardNavigationModeThe way tab is navigated to/from within this control.
[Tag]objectUsed to store an arbitrary object in script.

Related topics


Click to return to: Documentation | Designing Dashboards | General Controls | Frame

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.