Back to API Home
The DashboardAnalyticalControl type exposes the following members.
Constructors
Name | Description | |
---|---|---|
![]() | DashboardAnalyticalControl()()()() |
Initializes a new instance of the DashboardAnalyticalControl class.
|
![]() | DashboardAnalyticalControl(DashboardObjectCreateOptions) |
Initializes a new instance of the DashboardAnalyticalControl class.
|
Methods
Name | Description | |
---|---|---|
![]() | AnalyticalDataAdded |
This should be called when a virtual cube is added to a DV.
|
![]() | AnalyticalDataChanged |
This should be called when a analytical data is changed.
|
![]() | AnalyticalDataDeleted |
This should be called when an analytical data is deleted from a DV. The token returned from AnalyticalDataAdded should be given.
|
![]() | AnalyticalDataMoved |
This should be called when an analytical data is moved within a DV. The token returned from AnalyticalDataAdded should be given.
|
![]() | BeginBulkPropertyUpdate |
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.) |
![]() | Dispose |
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Inherited from DashboardObject.) |
![]() | EndBulkPropertyUpdate |
This should be called only if BeginBulkPropertyUpdate()()()() was called and all the properties that
had to be set are finished.
(Inherited from DashboardElement.) |
![]() | GetAllInteractionInfo |
Gets all the interactions defined on this dashboard element.
(Inherited from DashboardElement.) |
![]() | GetAllInteractions | Obsolete.
Gets all the interactions defined on this dashboard element.
(Inherited from DashboardElement.) |
![]() | GetBookmark |
Gets the bookmark from the underlying analytical control.
|
![]() | GetDesignTimeVisualElement |
Gets the design time visual element that the control represents.
(Inherited from DashboardObject.) |
![]() | GetElementWrapperType |
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.) |
![]() | GetExportData |
Gets the export data.
(Inherited from DashboardControl.) |
![]() | GetRegisteredScriptObjects |
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.) |
![]() | GetRegisteredScriptTypes |
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.) |
![]() | GetTokenById |
Gets the index of the token, or -1 if none is found.
|
![]() | GetTokenIndexById |
Gets the index of the token, or -1 if none is found.
|
![]() | GetValue<(Of <<'(T>)>>)(DependencyProperty, T) |
Gets the value.
(Inherited from DashboardObject.) |
![]() | GetValue<(Of <<'(T>)>>)(DependencyProperty, IValueConverter, Boolean) |
Gets the value.
(Inherited from DashboardObject.) |
![]() | GetValue<(Of <<'(T>)>>)(DependencyProperty, IValueConverter, T) |
Gets the value.
(Inherited from DashboardObject.) |
![]() | GetVisualElement |
Gets the visual element that the control represents.
(Inherited from DashboardObject.) |
![]() | IsAnalyticalDataSupported(AnalyticalDataParameters) |
Determines whether the analytical data which the designer wants to add to the DV is supported or not.
|
![]() | IsAnalyticalDataSupported(AnalyticalDataParameters, String%) |
Determines whether the analytical data which the designer wants to add to the DV is supported or not.
|
![]() | NotifyPropertyChanged |
This is the method to use for notification when a property changes (for INotifyPropertyChanged).
(Inherited from DashboardObject.) |
![]() | OnSerialized |
Called when serialization of this object has finished.
(Inherited from DashboardObject.) |
![]() | OnSerializing |
Called when serialization of this object has started.
(Inherited from DashboardObject.) |
![]() | SetBookmark |
Sets the bookmark on the underlying analytical control.
|
![]() | SetDesignTimeWrappedElement |
Sets the wrapped element (design time). This is used when a wrapper needs to be created from an existing element.
(Inherited from DashboardObject.) |
![]() | SetName |
Sets the Name property of this dashboard element.
(Inherited from DashboardElement.)
|
![]() | SetValue<(Of <<'(T>)>>)(DependencyProperty, Object) |
Sets the value.
(Inherited from DashboardObject.) |
![]() | SetValue<(Of <<'(T>)>>)(DependencyProperty, Object, String) |
Sets the value.
(Inherited from DashboardObject.) |
![]() | SetValue<(Of <<'(T>)>>)(DependencyProperty, Object, IValueConverter, Boolean) |
Sets the value.
(Inherited from DashboardObject.) |
![]() | SetValue<(Of <<'(T>)>>)(DependencyProperty, Object, IValueConverter, String) |
Sets the value.
(Inherited from DashboardObject.) |
![]() | SetValue<(Of <<'(T>)>>)(DependencyProperty, Object, IValueConverter, Boolean, String) |
Sets the value.
(Inherited from DashboardObject.) |
![]() | SetWrappedElement |
Sets the wrapped element. This is used when a wrapper needs to be created from an existing element.
(Inherited from DashboardObject.) |
![]() | ToString | (Inherited from DashboardElement.) |
Properties
Name | Description | |
---|---|---|
![]() | AcceleratorKey |
Gets or sets the accelerator key.
(Inherited from DashboardElement.) |
![]() | AccessKey |
Gets or sets the access key.
(Inherited from DashboardElement.) |
![]() | AnalyticalDataDescriptors |
Gets the analytical data descriptors information. This property is not serializable.
|
![]() | Background |
Gets or sets the background.
(Inherited from DashboardControl.) |
![]() | BorderBrush |
Gets or sets the border brush.
(Inherited from DashboardControl.) |
![]() | BorderThickness |
Gets or sets the border thickness.
(Inherited from DashboardControl.) |
![]() | BottomGuidelineName |
Gets or sets the name of the bottom guideline.
(Inherited from DashboardElement.) |
![]() | BottomPin |
Gets or sets a value indicating whether the bottom pin is enabled.
(Inherited from DashboardElement.) |
![]() | ClickInteractions |
Gets the click interactions.
(Inherited from DashboardElement.) |
![]() | ContextClickInteractions |
Gets the context click interactions.
(Inherited from DashboardElement.) |
![]() | Cursor |
Gets or sets the cursor.
(Inherited from DashboardElement.) |
![]() | CustomContextMenuCommands |
Gets or sets the custom context menu commands.
(Inherited from DashboardElement.) |
![]() | CustomFont |
Gets or sets the custom font.
(Inherited from DashboardControl.) |
![]() | Dashboard |
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.) |
![]() | DashboardStyle |
Gets or sets the dashboard style.
(Inherited from DashboardObject.) |
![]() | DerivedFriendlyName |
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.) |
![]() | DesignerVisibility |
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.) |
![]() | ExportOrder |
Gets or sets the export order.
(Inherited from DashboardElement.) |
![]() | FontFamily |
Gets or sets the font family.
(Inherited from DashboardControl.) |
![]() | FontSize |
Gets or sets the size of the font.
(Inherited from DashboardControl.) |
![]() | FontStretch |
Gets or sets the font stretch.
(Inherited from DashboardControl.) |
![]() | FontStyle |
Gets or sets the font style.
(Inherited from DashboardControl.) |
![]() | FontWeight |
Gets or sets the font weight.
(Inherited from DashboardControl.) |
![]() | Foreground |
Gets or sets the foreground.
(Inherited from DashboardControl.) |
![]() | FriendlyName |
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.) |
![]() | GroupNames |
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.) |
![]() | HasDesignTimeLoaded |
The component has been initialized for using in the designer.
(Inherited from DashboardObject.) |
![]() | Height |
Gets or sets the height of the control.
(Inherited from DashboardElement.) |
![]() | HelpText |
Gets or sets the help text.
(Inherited from DashboardElement.) |
![]() | HorizontalAlignment |
Gets or sets the horizontal alignment.
(Inherited from DashboardElement.) |
![]() | HoverDelay |
Gets or sets the hover delay.
(Inherited from DashboardElement.) |
![]() | HoverInteractions |
Gets the hover interactions.
(Inherited from DashboardElement.) |
![]() | Id |
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.) |
![]() | IsAnimationDisabled |
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.) |
![]() | IsBulkPropertyUpdating |
Gets a value indicating whether this instance is bulk porperty updating.
(Inherited from DashboardElement.) |
![]() | IsDesignTimeMode |
Gets a value indicating whether this instance is in design time mode.
(Inherited from DashboardObject.) |
![]() | IsEmpty |
Gets or sets a value indicating whether this instance is empty.
(Inherited from DashboardElement.) |
![]() | IsEnabled |
Gets or sets a value indicating whether this instance is enabled.
(Inherited from DashboardControl.) |
![]() | IsExportDisabled |
Gets or sets a value indicating whether this instance is not available for export.
(Inherited from DashboardElement.) |
![]() | IsHitTestVisible |
Gets or sets a whether an element is hit test visible. If it is, it can return values for hit-testing.
(Inherited from DashboardElement.) |
![]() | IsInteractionsDisabled |
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.) |
![]() | IsMultipleAnalyticalDatasSupported |
Gets a value indicating whether this instance is multiple analytical datas supported.
|
![]() | IsPreviewMode |
Gets a value indicating whether this instance is in preview mode.
(Inherited from DashboardObject.) |
![]() | IsUserCreated |
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.) |
![]() | Left |
Gets or sets the left.
(Inherited from DashboardElement.) |
![]() | LeftGuidelineName |
Gets or sets the name of the left guideline.
(Inherited from DashboardElement.) |
![]() | LeftPin |
Gets or sets a value indicating whether the left pin is enabled.
(Inherited from DashboardElement.) |
![]() | Margin |
Gets or sets the margin.
(Inherited from DashboardElement.) |
![]() | MaxHeight |
Gets or sets the maximum height.
(Inherited from DashboardElement.) |
![]() | MaxWidth |
Gets or sets the maximum width.
(Inherited from DashboardElement.) |
![]() | MinHeight |
Gets or sets the minimum height.
(Inherited from DashboardElement.) |
![]() | MinWidth |
Gets or sets the minimum width.
(Inherited from DashboardElement.) |
![]() | MouseEnterInteractions |
Gets the mouse enter interactions.
(Inherited from DashboardElement.) |
![]() | MouseLeaveInteractions |
Gets the mouse leave interactions.
(Inherited from DashboardElement.) |
![]() | MouseLeftButtonUpInteractions |
Gets the mouse left button up interactions.
(Inherited from DashboardElement.) |
![]() | MouseMoveInteractions |
Gets the mouse move interactions.
(Inherited from DashboardElement.) |
![]() | MouseRightButtonDownInteractions |
Gets the mouse left button up interactions.
(Inherited from DashboardElement.) |
![]() | Name |
Gets or sets the name of the control.
(Inherited from DashboardElement.) |
![]() | Opacity |
Gets or sets the opacity.
(Inherited from DashboardElement.) |
![]() | Padding |
Gets or sets the padding.
(Inherited from DashboardControl.) |
![]() | PositionType |
Gets or sets the type of the position.
(Inherited from DashboardElement.) |
![]() | RightGuidelineName |
Gets or sets the name of the right guideline.
(Inherited from DashboardElement.) |
![]() | RightPin |
Gets or sets a value indicating whether the right pin is enabled.
(Inherited from DashboardElement.) |
![]() | RotationAngle |
Gets or sets the rotation angle.
(Inherited from DashboardElement.) |
![]() | ScriptTypes |
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.) |
![]() | StyleResourceKey |
Gets or sets the style key.
(Inherited from DashboardObject.) |
![]() | TabIndex |
Gets or sets the index of the tab.
(Inherited from DashboardControl.) |
![]() | TabNavigation |
Gets or sets the tab navigation.
(Inherited from DashboardControl.) |
![]() | Tag |
Gets or sets an arbitrary object used in script. It is not serialized.
(Inherited from DashboardElement.) |
![]() | Tokens |
Gets or sets the tokens. These are what are used to link a KPI to a series in the visual object. The relationship may be one KPI
to many series.
|
![]() | ToolTip |
Gets or sets the tooltip.
(Inherited from DashboardElement.) |
![]() | Top |
Gets or sets the top.
(Inherited from DashboardElement.) |
![]() | TopGuidelineName |
Gets or sets the name of the top guideline.
(Inherited from DashboardElement.) |
![]() | TopPin |
Gets or sets a value indicating whether the top pin is enabled.
(Inherited from DashboardElement.) |
![]() | VerticalAlignment |
Gets or sets the vertical alignment.
(Inherited from DashboardElement.) |
![]() | Visibility |
Gets or sets the visibility.
(Inherited from DashboardElement.) |
![]() | VisualEffect |
Gets or sets the effect.
(Inherited from DashboardElement.) |
![]() | Width |
Gets or sets the width of the control.
(Inherited from DashboardElement.) |
Events
Name | Description | |
---|---|---|
![]() | IsEmptyChanged |
Occurs when the IsEmpty property changes. This is exposed as a separate event to assist the designer.
(Inherited from DashboardElement.) |
![]() | PropertyChanged |
Occurs when a property value changes.
(Inherited from DashboardObject.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
![]() ![]() | IPropertyVisibility..::..GetPropertyVisibility |
Gets the visibility of a property.
(Inherited from DashboardObject.) |