Back to API Home

The DashboardControl type exposes the following members.

Methods

  NameDescription
Public methodBeginBulkPropertyUpdate
This should be called before any sort of changes to many properties on a wrapper to give the control a chance to disable heavy re-drawing routines.
(Inherited from DashboardElement.)
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from DashboardObject.)
Public methodEndBulkPropertyUpdate
This should be called only if BeginBulkPropertyUpdate()()()() was called and all the properties that had to be set are finished.
(Inherited from DashboardElement.)
Public methodGetAllInteractionInfo
Gets all the interactions defined on this dashboard element.
(Inherited from DashboardElement.)
Public methodGetAllInteractions Obsolete.
Gets all the interactions defined on this dashboard element.
(Inherited from DashboardElement.)
Public methodGetDesignTimeVisualElement
Gets the design time visual element that the control represents.
(Inherited from DashboardObject.)
Public methodGetElementWrapperType
Gets the wrapper type used to wrap a visual element of the specified type, where it is a child in the visual tree of [P:VisualElement].
(Inherited from DashboardObject.)
Public methodGetExportData
Gets the export data.
Public methodGetRegisteredScriptObjects
Gets the registered script objects. This is a dictionary as the string is the alias which users reference your object with. For example, if you add the object "MyClass", and you make the alias "myClass", then users will use your type in script with: myClass.SomeMethod(); The instantiated class will be available for any script in the dashboard, so long as your control is on present on the dashboard.
(Inherited from DashboardElement.)
Public methodGetRegisteredScriptTypes
Gets the registered script types. This is a dictionary as the string is the alias which users reference your type with. For example, if you add the type "DashboardInt", and you make the alias "myInt", then users will use your type in script with: myInt myIntObject = new myInt(); Instead of DashboardInt.
(Inherited from DashboardElement.)
Public methodGetValue<(Of <<'(T>)>>)(DependencyProperty, T)
Gets the value.
(Inherited from DashboardObject.)
Public methodGetValue<(Of <<'(T>)>>)(DependencyProperty, IValueConverter, Boolean)
Gets the value.
(Inherited from DashboardObject.)
Public methodGetValue<(Of <<'(T>)>>)(DependencyProperty, IValueConverter, T)
Gets the value.
(Inherited from DashboardObject.)
Public methodGetVisualElement
Gets the visual element that the control represents.
(Inherited from DashboardObject.)
Public methodNotifyPropertyChanged
This is the method to use for notification when a property changes (for INotifyPropertyChanged).
(Inherited from DashboardObject.)
Public methodOnSerialized
Called when serialization of this object has finished.
(Inherited from DashboardObject.)
Public methodOnSerializing
Called when serialization of this object has started.
(Inherited from DashboardObject.)
Public methodSetDesignTimeWrappedElement
Sets the wrapped element (design time). This is used when a wrapper needs to be created from an existing element.
(Inherited from DashboardObject.)
Public methodSetName
Sets the Name property of this dashboard element.

Remarks

This method can be used to change the Name property without updating the DataVisualizationObjectName property of any associated data descriptors.
(Inherited from DashboardElement.)
Public methodSetValue<(Of <<'(T>)>>)(DependencyProperty, Object)
Sets the value.
(Inherited from DashboardObject.)
Public methodSetValue<(Of <<'(T>)>>)(DependencyProperty, Object, String)
Sets the value.
(Inherited from DashboardObject.)
Public methodSetValue<(Of <<'(T>)>>)(DependencyProperty, Object, IValueConverter, Boolean)
Sets the value.
(Inherited from DashboardObject.)
Public methodSetValue<(Of <<'(T>)>>)(DependencyProperty, Object, IValueConverter, String)
Sets the value.
(Inherited from DashboardObject.)
Public methodSetValue<(Of <<'(T>)>>)(DependencyProperty, Object, IValueConverter, Boolean, String)
Sets the value.
(Inherited from DashboardObject.)
Public methodSetWrappedElement
Sets the wrapped element. This is used when a wrapper needs to be created from an existing element.
(Inherited from DashboardObject.)
Public methodToString
Returns a String that represents the current Object.
(Inherited from DashboardElement.)

Fields

  NameDescription
Public fieldStatic memberCustomFontSuffix
String to use to indicate that the font family has been set using the CustomFont property.

Properties

  NameDescription
Public propertyAcceleratorKey
Gets or sets the accelerator key.
(Inherited from DashboardElement.)
Public propertyAccessKey
Gets or sets the access key.
(Inherited from DashboardElement.)
Public propertyBackground
Gets or sets the background.
Public propertyBorderBrush
Gets or sets the border brush.
Public propertyBorderThickness
Gets or sets the border thickness.
Public propertyBottomGuidelineName
Gets or sets the name of the bottom guideline.
(Inherited from DashboardElement.)
Public propertyBottomPin
Gets or sets a value indicating whether the bottom pin is enabled.
(Inherited from DashboardElement.)
Public propertyClickInteractions
Gets the click interactions.
(Inherited from DashboardElement.)
Public propertyContextClickInteractions
Gets the context click interactions.
(Inherited from DashboardElement.)
Public propertyCursor
Gets or sets the cursor.
(Inherited from DashboardElement.)
Public propertyCustomContextMenuCommands
Gets or sets the custom context menu commands.
(Inherited from DashboardElement.)
Public propertyCustomFont
Gets or sets the custom font.
Public propertyDashboard
Gets or sets the dashboard that this object currently resides on. This is currently only set automatically on the top-most element (the toolbox item). Any sub elements will have a new DashboardContent set to it, which is not the desired one.
(Inherited from DashboardObject.)
Public propertyDashboardStyle
Gets or sets the dashboard style.
(Inherited from DashboardObject.)
Public propertyDerivedFriendlyName
Gets the derived friendly name. This is a safe name to use when you want a friendly name, since FriendlyName is not guaranteed to be set.
(Inherited from DashboardElement.)
Public propertyDesignerVisibility
Gets or sets the visibility of the control in the designer. Setting this property does not affect the visibility of the element in the viewer.
(Inherited from DashboardElement.)
Public propertyExportOrder
Gets or sets the export order.
(Inherited from DashboardElement.)
Public propertyFontFamily
Gets or sets the font family.
Public propertyFontSize
Gets or sets the size of the font.
Public propertyFontStretch
Gets or sets the font stretch.
Public propertyFontStyle
Gets or sets the font style.
Public propertyFontWeight
Gets or sets the font weight.
Public propertyForeground
Gets or sets the foreground.
Public propertyFriendlyName
Gets or sets the friendly name of the control. When read, the property DerivedFriendlyName should be used instead of this one from code as this one is not guaranteed to be set, in which case the Name property will be used instead.
(Inherited from DashboardElement.)
Public propertyGroupNames
Gets or sets the group names. This is the names of all the groups this control is a part of. Groups allow code to modify multiple controls at once.
(Inherited from DashboardElement.)
Public propertyHasDesignTimeLoaded
The component has been initialized for using in the designer.
(Inherited from DashboardObject.)
Public propertyHeight
Gets or sets the height of the control.
(Inherited from DashboardElement.)
Public propertyHelpText
Gets or sets the help text.
(Inherited from DashboardElement.)
Public propertyHorizontalAlignment
Gets or sets the horizontal alignment.
(Inherited from DashboardElement.)
Public propertyHoverDelay
Gets or sets the hover delay.
(Inherited from DashboardElement.)
Public propertyHoverInteractions
Gets the hover interactions.
(Inherited from DashboardElement.)
Public propertyId
Gets or sets the id. This is not used yet, but will eventually co-exist with Name in the future to provide better linking for data descriptors.
(Inherited from DashboardElement.)
Public propertyIsAnimationDisabled
Gets or sets a value indicating whether animation should be disabled for this wrapper. This property should be checked by the wrapper during the OnGetVisualElement()()()() override and, if set to trueTruetruetrue (True in Visual Basic), any animation properties should be set to appropriate values in order to disable animation.
(Inherited from DashboardElement.)
Public propertyIsBulkPropertyUpdating
Gets a value indicating whether this instance is bulk porperty updating.
(Inherited from DashboardElement.)
Public propertyIsDesignTimeMode
Gets a value indicating whether this instance is in design time mode.
(Inherited from DashboardObject.)
Public propertyIsEmpty
Gets or sets a value indicating whether this instance is empty.
(Inherited from DashboardElement.)
Public propertyIsEnabled
Gets or sets a value indicating whether this instance is enabled.
Public propertyIsExportDisabled
Gets or sets a value indicating whether this instance is not available for export.
(Inherited from DashboardElement.)
Public propertyIsHitTestVisible
Gets or sets a whether an element is hit test visible. If it is, it can return values for hit-testing.
(Inherited from DashboardElement.)
Public propertyIsInteractionsDisabled
Gets or sets a value indicating whether this instance has interactions disabled. If disabled, no interactions should be run. It is up to the wrapper to ensure that this is the case. This should only be set when everything should not run, including the context menu, as it will also not show up.
(Inherited from DashboardObject.)
Public propertyIsPreviewMode
Gets a value indicating whether this instance is in preview mode.
(Inherited from DashboardObject.)
Public propertyIsUserCreated
Gets a value indicating whether this object was created by a user. If this is trueTruetruetrue (True in Visual Basic), then this object is not creating due to de-serialization, but instead due to construction by a user. This value will not be available until the OnGetVisualElement()()()() and OnGetDesignTimeVisualElement()()()() calls. Before that, it's not guaranteed this property represents the true state of this object.
(Inherited from DashboardObject.)
Public propertyLeft
Gets or sets the left.
(Inherited from DashboardElement.)
Public propertyLeftGuidelineName
Gets or sets the name of the left guideline.
(Inherited from DashboardElement.)
Public propertyLeftPin
Gets or sets a value indicating whether the left pin is enabled.
(Inherited from DashboardElement.)
Public propertyMargin
Gets or sets the margin.
(Inherited from DashboardElement.)
Public propertyMaxHeight
Gets or sets the maximum height.
(Inherited from DashboardElement.)
Public propertyMaxWidth
Gets or sets the maximum width.
(Inherited from DashboardElement.)
Public propertyMinHeight
Gets or sets the minimum height.
(Inherited from DashboardElement.)
Public propertyMinWidth
Gets or sets the minimum width.
(Inherited from DashboardElement.)
Public propertyMouseEnterInteractions
Gets the mouse enter interactions.
(Inherited from DashboardElement.)
Public propertyMouseLeaveInteractions
Gets the mouse leave interactions.
(Inherited from DashboardElement.)
Public propertyMouseLeftButtonUpInteractions
Gets the mouse left button up interactions.
(Inherited from DashboardElement.)
Public propertyMouseMoveInteractions
Gets the mouse move interactions.
(Inherited from DashboardElement.)
Public propertyMouseRightButtonDownInteractions
Gets the mouse left button up interactions.
(Inherited from DashboardElement.)
Public propertyName
Gets or sets the name of the control.
(Inherited from DashboardElement.)
Public propertyOpacity
Gets or sets the opacity.
(Inherited from DashboardElement.)
Public propertyPadding
Gets or sets the padding.
Public propertyPositionType
Gets or sets the type of the position.
(Inherited from DashboardElement.)
Public propertyRightGuidelineName
Gets or sets the name of the right guideline.
(Inherited from DashboardElement.)
Public propertyRightPin
Gets or sets a value indicating whether the right pin is enabled.
(Inherited from DashboardElement.)
Public propertyRotationAngle
Gets or sets the rotation angle.
(Inherited from DashboardElement.)
Public propertyScriptTypes
Gets the script types. The script types are additional types that this element wants to add to the script engine for build and run.
(Inherited from DashboardElement.)
Public propertyStyleResourceKey
Gets or sets the style key.
(Inherited from DashboardObject.)
Public propertyTabIndex
Gets or sets the index of the tab.
Public propertyTabNavigation
Gets or sets the tab navigation.
Public propertyTag
Gets or sets an arbitrary object used in script. It is not serialized.
(Inherited from DashboardElement.)
Public propertyToolTip
Gets or sets the tooltip.
(Inherited from DashboardElement.)
Public propertyTop
Gets or sets the top.
(Inherited from DashboardElement.)
Public propertyTopGuidelineName
Gets or sets the name of the top guideline.
(Inherited from DashboardElement.)
Public propertyTopPin
Gets or sets a value indicating whether the top pin is enabled.
(Inherited from DashboardElement.)
Public propertyVerticalAlignment
Gets or sets the vertical alignment.
(Inherited from DashboardElement.)
Public propertyVisibility
Gets or sets the visibility.
(Inherited from DashboardElement.)
Public propertyVisualEffect
Gets or sets the effect.
(Inherited from DashboardElement.)
Public propertyWidth
Gets or sets the width of the control.
(Inherited from DashboardElement.)

Events

  NameDescription
Public eventIsEmptyChanged
Occurs when the IsEmpty property changes. This is exposed as a separate event to assist the designer.
(Inherited from DashboardElement.)
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from DashboardObject.)

Explicit Interface Implementations

  NameDescription
Explicit interface implemetationPrivate methodIPropertyVisibility..::..GetPropertyVisibility
Gets the visibility of a property.
(Inherited from DashboardObject.)

See Also