Back to API Home

The DashboardElement 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.
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.
Public methodGetAllInteractionInfo
Gets all the interactions defined on this dashboard element.
Public methodGetAllInteractions Obsolete.
Gets all the interactions defined on this dashboard element.
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 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.
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.
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.
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.
(Overrides DashboardObject..::..ToString()()()().)

Fields

  NameDescription
Public fieldStatic memberAnnotateThisCommandId
The command Id used for "Annotate This".
Public fieldStatic memberExportThisCommandId
The command Id used for "Export This".
Public fieldStatic memberNotifyOnThisCommandId
The command Id used for "Notify on This".
Public fieldStatic memberPrintThisCommandId
The command Id used for "Print This".

Properties

  NameDescription
Public propertyAcceleratorKey
Gets or sets the accelerator key.
Public propertyAccessKey
Gets or sets the access key.
Public propertyBottomGuidelineName
Gets or sets the name of the bottom guideline.
Public propertyBottomPin
Gets or sets a value indicating whether the bottom pin is enabled.
Public propertyClickInteractions
Gets the click interactions.
Public propertyContextClickInteractions
Gets the context click interactions.
Public propertyCursor
Gets or sets the cursor.
Public propertyCustomContextMenuCommands
Gets or sets the custom context menu commands.
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.
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.
Public propertyExportOrder
Gets or sets the export order.
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.
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.
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.
Public propertyHelpText
Gets or sets the help text.
Public propertyHorizontalAlignment
Gets or sets the horizontal alignment.
Public propertyHoverDelay
Gets or sets the hover delay.
Public propertyHoverInteractions
Gets the hover interactions.
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.
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.
Public propertyIsBulkPropertyUpdating
Gets a value indicating whether this instance is bulk porperty updating.
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.
Public propertyIsExportDisabled
Gets or sets a value indicating whether this instance is not available for export.
Public propertyIsHitTestVisible
Gets or sets a whether an element is hit test visible. If it is, it can return values for hit-testing.
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.
Public propertyLeftGuidelineName
Gets or sets the name of the left guideline.
Public propertyLeftPin
Gets or sets a value indicating whether the left pin is enabled.
Public propertyMargin
Gets or sets the margin.
Public propertyMaxHeight
Gets or sets the maximum height.
Public propertyMaxWidth
Gets or sets the maximum width.
Public propertyMinHeight
Gets or sets the minimum height.
Public propertyMinWidth
Gets or sets the minimum width.
Public propertyMouseEnterInteractions
Gets the mouse enter interactions.
Public propertyMouseLeaveInteractions
Gets the mouse leave interactions.
Public propertyMouseLeftButtonUpInteractions
Gets the mouse left button up interactions.
Public propertyMouseMoveInteractions
Gets the mouse move interactions.
Public propertyMouseRightButtonDownInteractions
Gets the mouse left button up interactions.
Public propertyName
Gets or sets the name of the control.
Public propertyOpacity
Gets or sets the opacity.
Public propertyPositionType
Gets or sets the type of the position.
Public propertyRightGuidelineName
Gets or sets the name of the right guideline.
Public propertyRightPin
Gets or sets a value indicating whether the right pin is enabled.
Public propertyRotationAngle
Gets or sets the rotation angle.
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.
Public propertyStyleResourceKey
Gets or sets the style key.
(Inherited from DashboardObject.)
Public propertyTag
Gets or sets an arbitrary object used in script. It is not serialized.
Public propertyToolTip
Gets or sets the tooltip.
Public propertyTop
Gets or sets the top.
Public propertyTopGuidelineName
Gets or sets the name of the top guideline.
Public propertyTopPin
Gets or sets a value indicating whether the top pin is enabled.
Public propertyVerticalAlignment
Gets or sets the vertical alignment.
Public propertyVisibility
Gets or sets the visibility.
Public propertyVisualEffect
Gets or sets the effect.
Public propertyWidth
Gets or sets the width of the control.

Events

  NameDescription
Public eventIsEmptyChanged
Occurs when the IsEmpty property changes. This is exposed as a separate event to assist the designer.
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