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.

Data Grid - Properties

Hide navigation
RSS
Modified on Fri, 22 Nov 2013 03:17 PM Categorized as Data Controls, Data Grid, Design
Click to return to: Documentation | Designing Dashboards | DV Controls | Data Grid

Table of Contents [Hide/Show]


Overview

This article describes the properties of the Dundas Dashboard Data Grid 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
ImageImageAre Groups Expanded [AreGroupsExpanded]boolValue indicating whether the groups are expanded by default
ImageColumns [Columns]DashboardDataGridColumnCollectionThe columns within the data grid.
[DerivedFriendlyName]stringGets the name based on FriendlyName if set, otherwise Name.
ImageDisable Exporting [Not_accessible_in_script_editor] If this is set to true, this control will not appear in the export wizard or be available for export in any other way.
ImageEnable Sub Totals [AreSubTotalsEnabled]boolValue indicating whether the sub totals are enabled
ImageEnable Totals [AreTotalsEnabled]boolValue indicating whether the totals are enabled
ImageEnabled [IsEnabled]boolIndicates whether this control can be interacted with. Some controls have a different appearance when not enabled.
ImageExpand Groups on Export [AreGroupsExpandedOnExport]boolValue indicating whether the groups are expanded when exporting
ImageExport Order [Not_accessible_in_script_editor] Defines an order in which the control is exported.
Friendly Name [FriendlyName]stringThe friendly name of the control which will appear to viewers and should be easily identifiable for them.
Group Descriptions [GroupDescriptions]ObservableCollection
<DashboardDataGridGroupDescription>
The group descriptions for the data.
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.
ImageImageSelection Mode [SelectionMode]DataGridSelectionModeSelection mode.
Tooltip [ToolTip]stringThe tooltip typically shows up when the user hovers over the element with their mouse.
ImageView [View]DashboardDataGridViewAssign and configure the data grid view.

Appearance

ImageImageProperty Name [Script Name]TypeDescription
ImageAlternate Row Styles [AlternateRowStyles]ObservableCollection
<DashboardDataGridRowStyle>
Alternate Row Styles.
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.
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.
ImageRow Styles [RowStyles]ObservableCollection
<DashboardDataGridRowStyle>
Row Styles.
Style [Not_accessible_in_script_editor] The style to use on this dashboard object.
ImageTotal Row Style [TotalRowStyle]DashboardDataGridRowStyleAllows customizing the total row's appearance.
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.
ImageMaximum Height [MaxHeight]doubleSets the maximum height for a control. During re-size, the control will not go more than this value.
ImageMaximum Width [MaxWidth]doubleSets the maximum width for a control. During re-size, the control will not go more than this value.
ImageMinimum Height [MinHeight]doubleSets the minimum height for a control. During re-size, the control will not go less than this value.
ImageMinimum Width [MinWidth]doubleSets the minimum width for a control. During re-size, the control will not go less than this value.
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.
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.

Data

ImageImageProperty Name [Script Name]TypeDescription
Data Columns [DataColumns]ObservableCollection
<DashboardDataGridDataSourceColumn>
The data columns.
ImageData Pager [DataPager]DashboardDataGridDataPagerAllows defining paging settings and appearance.
ImageData Pager Dock Location [DataPagerDockLocation]DataPagerDockLocationAllows defining pager dock location.
Data Relationships [DataDescriptorRelationships]ObservableCollection
<DashboardDataGridDataDescriptorRelationship>
The data sources relationships will define how the parent and child data sources are linked.
Master Data Source [MasterDataDescriptorScopeId]GuidThe master data source will be used to display scorecard rows.
Primary Data Sources [PrimaryDashboardDataDescriptorScopeIds]ObservableCollection
<Guid>
The primary data sources will be be displayed each on a scorecard row.
Secondary Data Sources [SecondaryDashboardDataDescriptorScopeIds]ObservableCollection
<Guid>
The secondary data sources will be be displayed on scorecard columns.

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.
ImageAnnotation Adding Disabled [IsAnnotationAddingDisabled]boolIndicates whether adding annotations is disabled on this dashboard control. If disabled, viewers will not be able to add annotations to this control.
ImageImageCell Annotation Rectangle [Not_accessible_in_script_editor] Allows styling the cell annotation rectangle.
ImageCustom Context Menu Commands [CustomContextMenuCommands]InteractionCommandCollectionThe custom commands appended to the context menu for the dashboard and any elements which don't have their own context menu.
[DataDescriptors]Collection<DashboardDataDescriptor>A collection containing a descriptor for each KPI or dataset displayed on this control.
ImageDisable Loading Data [IsLoadingDataDisabled]boolPrevents the control from loading data.
HasDesignTimeLoaded [HasDesignTimeLoaded]bool
Help Text [HelpText]stringThis is the help text for accessibility.
ImageHover Delay [HoverDelay]doubleThe number of seconds that have to elapse before the hover interaction event fires.
[LoadedRows]ReadOnlyCollection<DashboardDataGridRow>Gets the loaded rows.
[MasterDataDescriptor]DashboardDataDescriptorGets the master data descriptor.
[PrimaryDataDescriptors]ReadOnlyCollection<DashboardDataDescriptor>Gets the primary data descriptors.
ImageImageRow Annotation Rectangle [Not_accessible_in_script_editor] Allows styling the row annotation rectangle.
[SecondaryDataDescriptors]ReadOnlyCollection<DashboardDataDescriptor>Gets the secondary data descriptors.
[SelectedItem]objectGets or sets the selected item.
[SelectedItems]ObservableCollection<object>Gets the selected items.
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 | DV Controls | Data Grid

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

Copyright © 2009-2014 Dundas Data Visualization, Inc.