StiIndicatorElement Class |
Indicator component of the dashboards.
Inheritance HierarchySystemObject
Stimulsoft.Base.ServicesStiService
Stimulsoft.ReportStiBase
Stimulsoft.Report.ComponentsStiComponent
Stimulsoft.Dashboard.ComponentsStiElement
Stimulsoft.Dashboard.Components.IndicatorStiIndicatorElement
Stimulsoft.Base.ServicesStiService
Stimulsoft.ReportStiBase
Stimulsoft.Report.ComponentsStiComponent
Stimulsoft.Dashboard.ComponentsStiElement
Stimulsoft.Dashboard.Components.IndicatorStiIndicatorElement
Namespace: Stimulsoft.Dashboard.Components.Indicator
Assembly: Stimulsoft.Dashboard (in Stimulsoft.Dashboard.dll) Version: 2019.3.1.0
Syntaxpublic class StiIndicatorElement : StiElement, IStiTextFormat, IStiIndicatorElement, IStiElement, IStiReportComponent, IStiAppComponent, IStiAppCell, IStiRetrieval, IStiDashboardElementStyle, IStiTransformActions, IStiTransformFilters, IStiTransformSorts, IStiDataTopN, IStiDataTransformationElement, IStiGroupElement, IStiDataFilters, IStiConvertibleElement, IStiTitleElement, IStiFont, IStiForeColor, IStiElementLayout, IStiGlobalizationProvider
The StiIndicatorElement type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | StiIndicatorElement |
Creates a new component of the type StiIndicatorElement.
|
| StiIndicatorElement(RectangleD) |
Creates a new component of the type StiIndicatorElement with specified location.
|
Properties| Name | Description | |
|---|---|---|
 | AfterPrintEvent | (Inherited from StiElement.) |
| Alias |
Gets or sets a text that will be shown instead of a component name.
If the text is not indicated then the name is shown.
(Inherited from StiComponent.) |
| AllowDelete |
Gets a value which indicates whether deleting of the components is allowed.
(Inherited from StiComponent.) |
| Anchor | (Inherited from StiElement.) |
| BackColor |
Gets or sets a back color.
(Inherited from StiElement.) |
| BeforePrintEvent | (Inherited from StiElement.) |
| Bookmark | (Inherited from StiElement.) |
| BookmarkValue |
Gets or sets the component bookmark.
(Inherited from StiComponent.) |
| Border |
Gets or sets border of the element.
(Inherited from StiElement.) |
| Bottom |
Gets bottom position of a component.
(Inherited from StiComponent.) |
| CanGrow | (Inherited from StiElement.) |
| CanShrink | (Inherited from StiElement.) |
| ClickEvent | (Inherited from StiElement.) |
| ClientRectangle |
Gets or sets the client area of a component.
(Inherited from StiComponent.) |
| ComponentId |
ID code of this component. Used in JSON saving.
(Overrides StiComponentComponentId.) |
| ComponentPlacement |
Gets or sets a value which indicates placement of a simple component.
Available values:
"rt" - StiReportTitleBand
"rs" - StiReportSummaryBand
"ph" - StiPageHeaderBand
"pf" - StiPageFooterBand
"h" - StiHeaderBand
"h.ap" - StiHeaderBand (OnAllPages)
"f" - StiFooterBand
"f.ap" - StiFooterBand (OnAllPages)
"d" - StiDataBand
"gh" - StiGroupHeaderBand
"gf" - StiGroupFooterBand
"e" - StiEmptyBand
"p" - StiPage
(Inherited from StiComponent.) |
| ComponentStyle | (Inherited from StiElement.) |
| ComponentType |
Gets the type of processing when printing.
(Inherited from StiComponent.) |
| Conditions | (Inherited from StiElement.) |
| CurrentBookmark |
Gets or sets current bookmark for this component.
(Inherited from StiComponent.) |
| CustomIcon | |
| CustomStyleName | |
| Dashboard | (Inherited from StiElement.) |
| DataFilters | |
| DataTransformation | |
| DefaultClientRectangle |
Gets or sets the default client area of a component.
(Overrides StiElementDefaultClientRectangle.) |
| DelimiterComponent |
Gets or sets a value indicates that this component is used as the delimiter.
(Inherited from StiComponent.) |
| DisplayRectangle |
Gets or sets a rectangle of the component which it fills. Docking occurs in accordance to the area of a component
(Cross - components are docked by ClientRectangle).
(Inherited from StiComponent.) |
| Dockable |
Gets or sets a value which indicates whether the component will be docked or not.
(Inherited from StiComponent.) |
| DockStyle | (Inherited from StiElement.) |
| DoubleClickEvent | (Inherited from StiElement.) |
| DrillDownParameters | (Inherited from StiComponent.) |
| Enabled |
Gets or sets a value which indicates will this component be available or not.
(Inherited from StiElement.) |
 | Events | (Inherited from StiComponent.) |
| Font |
Gets or sets the font of the text displayed by the control.
|
| ForceRedrawAll |
Gets a value which indicates whether it is necessary to draw again the whole page when moving the component or
changing its sizes in the designer.
(Inherited from StiComponent.) |
| ForeColor |
Gets or sets font color for this element.
|
| GetBookmarkEvent | (Inherited from StiElement.) |
| GetDrillDownReportEvent | (Inherited from StiElement.) |
| GetHyperlinkEvent | (Inherited from StiElement.) |
| GetTagEvent | (Inherited from StiElement.) |
| GetToolTipEvent | (Inherited from StiElement.) |
| GlyphColor |
Gets or sets glyph color for this element.
|
| Group | |
| GrowToHeight | (Inherited from StiElement.) |
| Guid |
Gets or sets a guid of component.
(Inherited from StiComponent.) |
| Height | (Inherited from StiElement.) |
| HelpUrl | (Overrides StiComponentHelpUrl.) |
| HighlightState |
Gets or sets a state of highlight.
(Inherited from StiComponent.) |
| Hyperlink | (Inherited from StiElement.) |
| HyperlinkValue |
Gets or sets hyperlink of a component.
(Inherited from StiComponent.) |
| Icon | |
| IconSet | |
| IgnoreNamingRule |
Internal use only.
(Inherited from StiComponent.) |
| Inherited | (Inherited from StiComponent.) |
| Interaction | (Inherited from StiElement.) |
| InvalidateOnMouseOver |
Gets a value which indicates whether invalidating of the component occurs when a mouse pointer is above the component.
(Inherited from StiComponent.) |
| IsAutomaticDock |
Gets a value which indicates that this is an automatic docking.
(Inherited from StiComponent.) |
| IsCross |
Gets a value indicating that this is the Cross component.
(Inherited from StiComponent.) |
| IsDefined | (Overrides StiElementIsDefined.) |
| IsDesigning |
Gets a value which indicates that the report in which a component is placed is being designed.
(Inherited from StiComponent.) |
| IsEnabled | (Inherited from StiElement.) |
| IsEventEmpty |
Gets a value which indicates that all events are empty.
(Inherited from StiComponent.) |
| IsExporting |
Gets or sets value, which indicates that the report is exporting.
(Inherited from StiComponent.) |
| IsPrinting |
Gets a value which indicates that the component has already been printed.
(Inherited from StiComponent.) |
| IsQuerable | (Inherited from StiElement.) |
| IsRendered |
Gets or sets a value which indicates whether the component is rendered or not.
(Inherited from StiComponent.) |
| IsSelected |
Gets or sets value indicates is the component selected or not.
(Inherited from StiComponent.) |
| Key | (Inherited from StiElement.) |
| Layout |
Gets layout of the element.
|
| Left | (Inherited from StiElement.) |
| Linked |
Gets or sets a value which indicates whether the object snap to the container is turned on.
(Inherited from StiComponent.) |
| LocalizedCategory |
Gets a localized name of the component category.
(Inherited from StiElement.) |
| LocalizedName |
Gets a localized component name.
(Overrides StiElementLocalizedName.) |
| Locked |
Gets or sets a value which indicates that moving is locked.
(Inherited from StiComponent.) |
| Margin |
Gets or sets element margin.
(Inherited from StiElement.) |
| MaxSize | (Inherited from StiElement.) |
| MinSize | (Inherited from StiElement.) |
| MouseEnterEvent | (Inherited from StiElement.) |
| MouseLeaveEvent | (Inherited from StiElement.) |
| Name |
Gets or sets a name of a component.
(Inherited from StiComponent.) |
| Padding |
Gets or sets element padding.
(Inherited from StiElement.) |
| Page |
Gets or sets the page on which an object is located.
(Inherited from StiComponent.) |
| Parent |
Gets or sets the container in which an object is located.
(Inherited from StiComponent.) |
| ParentBookmark |
Gets or sets parent bookmark for this component.
(Inherited from StiComponent.) |
| PlaceOnToolbox |
Gets or sets a value which indicates whether it is necessary to place component in toolbox or not.
(Inherited from StiComponent.) |
| Printable | (Inherited from StiElement.) |
| PrintOn | (Inherited from StiElement.) |
| Priority |
Gets a component priority.
(Inherited from StiComponent.) |
| Properties | (Inherited from StiService.) |
| PropName | (Inherited from StiComponent.) |
| RenderedCount |
Gets or sets a value which indicates how many times the component is rendered.
(Inherited from StiComponent.) |
| Report |
Gets or sets the report in which the component is located.
(Inherited from StiComponent.) |
| Restrictions |
Gets or sets value which indicates the restrictions of a component.
(Inherited from StiComponent.) |
| Right |
Gets right position of a component.
(Inherited from StiComponent.) |
| SelectionTick | (Inherited from StiComponent.) |
| SelectRectangle |
Gets or sets a rectangle of a component selection.
(Inherited from StiComponent.) |
| Series | |
| ServiceCategory |
Gets a service category.
(Inherited from StiElement.) |
| ServiceEnabled | (Inherited from StiService.) |
| ServiceInfo | (Inherited from StiService.) |
| ServiceName |
Gets a service name.
(Inherited from StiBase.) |
| ServiceType |
Gets a service type.
(Inherited from StiComponent.) |
| Shift |
Gets or sets a value which indicates that this component can be shifted.
(Inherited from StiComponent.) |
| ShiftMode | (Inherited from StiElement.) |
| ShowQuickButtons |
Gets or sets a value which indicates whether it is necessary to show quick buttons.
(Inherited from StiComponent.) |
| States |
Gets the component states manager.
(Inherited from StiComponent.) |
| Style | |
| Tag |
Gets or sets the expression to fill a component tag.
(Inherited from StiComponent.) |
| TagValue |
Gets or sets tag of a component.
(Inherited from StiComponent.) |
| Target | |
| TextFormat |
Gets or sets the format of the text.
|
| Title | |
| ToolboxCategory | (Inherited from StiElement.) |
| ToolboxPosition |
Gets value to sort a position in the toolbox.
(Overrides StiComponentToolboxPosition.) |
| ToolTip |
Gets or sets the expression to fill a component tooltip.
(Inherited from StiComponent.) |
| ToolTipValue |
Gets or sets a component tips.
(Inherited from StiComponent.) |
| Top | (Inherited from StiElement.) |
| TopN | |
| TransformActions | |
| TransformFilters | |
| TransformSorts | |
| UseParentStyles | (Inherited from StiElement.) |
| Value | |
| Width | (Inherited from StiElement.) |
| Zoom | (Inherited from StiElement.) |
Methods| Name | Description | |
|---|---|---|
| AddSeries(IStiMeter) | |
| AddSeries(StiDataColumn) | |
| AddSize |
Increases the amount of pages on width and on height.
Herewith on width or height of the page change all sizes a parent component.
(Inherited from StiComponent.) |
| AddTarget(IStiMeter) | |
| AddTarget(StiDataColumn) | |
| AddValue(IStiMeter) | |
| AddValue(StiDataColumn) | |
 | AllowPrintOn | (Inherited from StiComponent.) |
| CanContainIn |
May this container be located in the specified component.
(Inherited from StiElement.) |
| ClearAllStates |
Clears all earlier saved object states.
(Inherited from StiComponent.) |
| ClearContents |
Clears a text of all selected components.
(Inherited from StiComponent.) |
| Clone |
Creates a new object that is a copy of the current instance.
(Inherited from StiComponent.) |
| Clone(Boolean) |
Creates a new object that is a copy of the current instance.
(Overrides StiElementClone(Boolean).) |
| ComponentToPage(Double) |
Converts a value from the parent-container coordinates into coordinates of a page.
The method calls the ContainerToPage method of the parent component.
(Inherited from StiComponent.) |
| ComponentToPage(PointD) |
Converts a point from the parent-container coordinates into coordinates of a page.
The method calls the ContainerToPage method of the parent component.
(Inherited from StiComponent.) |
| ComponentToPage(RectangleD) |
Converts a rectangle from the parent-container coordinates into coordinates of a page.
The method calls the ContainerToPage method of the parent component.
(Inherited from StiComponent.) |
| Convert | (Inherited from StiElement.) |
| ConvertFrom | |
| CreateNew | (Overrides StiComponentCreateNew.) |
| CreateNewSeries | |
| CreateNewTarget | |
| CreateNewValue | |
| DoBookmark |
Invokes the GetBookmark event.
(Inherited from StiComponent.) |
| DockToContainer |
Docks the component and all of its subordinate components.
(Inherited from StiComponent.) |
| DockToContainer(RectangleD) |
Docks a rectangle, relatively to the component, into the rectangle.
(Inherited from StiComponent.) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| FetchAllMeters | (Overrides StiElementFetchAllMeters.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetActualSize |
Initializes a new instance of the SizeD class from the specified dimensions.
(Inherited from StiComponent.) |
| GetContainer |
Returns the topmost Container(StiPanel or StiPage) in which the component is located.
Returns null, if nothing is located.
(Inherited from StiComponent.) |
| GetDataBand |
Returns the DataBand in which the component is located.
Returns null, if nothing is located.
(Inherited from StiComponent.) |
| GetDefaultEvent |
Gets default event for this report control.
(Inherited from StiElement.) |
| GetDictionary | (Inherited from StiElement.) |
| GetDisplayRectangle |
Returns a rectangle of the component showing.
(Inherited from StiComponent.) |
| GetDockRegion(StiComponent) |
Retuns an empty rectangle to which docking is possible.
(Inherited from StiComponent.) |
| GetDockRegion(StiComponent, Boolean) |
Retuns an empty rectangle to which docking is possible.
(Inherited from StiComponent.) |
| GetEvents |
Return events collection of this component;
(Inherited from StiElement.) |
| GetEvents(IStiPropertyGrid) | (Inherited from StiComponent.) |
| GetGroupHeaderBand |
Returns the GroupHeaderBand in which the component is located.
Returns null, if nothing is located.
(Inherited from StiComponent.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetLevel |
Returns the level of the object nesting.
Level 1 - page, 2 - page and etc.
(Inherited from StiComponent.) |
| GetMeasureGraphics | (Inherited from StiComponent.) |
| GetMeters | (Overrides StiElementGetMeters.) |
| GetNestedPages |
Returns a list of the nested pages.
(Inherited from StiElement.) |
| GetPaintRectangle |
Makes all necessary coversions for showing an object and returns its coordinates.
(Inherited from StiComponent.) |
| GetPaintRectangle(Boolean, Boolean) |
Makes all necessary conversions for the object output and returns its coordinates.
(Inherited from StiComponent.) |
| GetPaintRectangle(Boolean, Boolean, Boolean) |
Makes all necessary conversions for the object output and returns its coordinates.
(Inherited from StiComponent.) |
| GetProperties | (Inherited from StiComponent.) |
| GetQuickInfo | (Inherited from StiComponent.) |
| GetReport | (Inherited from StiComponent.) |
| GetSeries | |
| GetSeries(IStiMeter) | |
| GetTarget | |
| GetTarget(IStiMeter) | |
| GetThumbnail(Int32, Boolean) |
Gets a thumbnail image of the component.
(Inherited from StiComponent.) |
| GetThumbnail(Int32, Int32) |
Gets a thumbnail image of the component.
(Inherited from StiComponent.) |
| GetThumbnail(Int32, Int32, Boolean) |
Gets a thumbnail image of the component.
(Inherited from StiComponent.) |
| GetThumbnailAsBytes |
Gets a thumbnail image in the byte aray of the component.
(Inherited from StiComponent.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| GetValue | |
| GetValue(IStiMeter) | |
| InternalRender | (Inherited from StiComponent.) |
| InternalRender(StiComponent, StiContainer) |
Renders a component in the specified container without generation of the 'BeforePrintEvent' event and the 'AfterPrintEvent' event and
without checking Conditions. The rendered component will return in 'renderedComponent' argument.
(Inherited from StiComponent.) |
| Invert |
Invert selection of component.
(Inherited from StiComponent.) |
| InvokeAfterPrint |
Raises the AfterPrint event.
(Inherited from StiComponent.) |
| InvokeBeforePrint |
Raises the BeforePrint event.
(Inherited from StiComponent.) |
| InvokeClick |
Raises the Click event for this report.
(Inherited from StiComponent.) |
| InvokeDoubleClick |
Raises the DoubleClick event for this report.
(Inherited from StiComponent.) |
| InvokeEvents |
Invokes all events for this components.
(Inherited from StiComponent.) |
| InvokeGetBookmark |
Raises the GetBookmark event.
(Inherited from StiComponent.) |
| InvokeGetDrillDownReport |
Raises the GetDrillDownReport event for this report.
(Inherited from StiComponent.) |
| InvokeGetHyperlink |
Raises the GetHyperlink event.
(Inherited from StiComponent.) |
| InvokeGetTag |
Raises the GetTag event.
(Inherited from StiComponent.) |
| InvokeGetToolTip |
Raises the GetToolTip event.
(Inherited from StiComponent.) |
| InvokeMouseEnter |
Raises the MouseEnter event for this report.
(Inherited from StiComponent.) |
| InvokeMouseLeave |
Raises the MouseLeave event for this report.
(Inherited from StiComponent.) |
| InvokePainted |
Raises the Painted event for this component.
(Inherited from StiComponent.) |
| InvokePainting |
Raises the Painting event for this component.
(Inherited from StiComponent.) |
| IsDefaultDataTransformation | |
| IsExportAsImage | (Inherited from StiComponent.) |
| IsPropertiesInitializedProtected | (Inherited from StiService.) |
| IsPropertyPresent | (Inherited from StiService.) |
| LoadFromJsonObject | (Overrides StiElementLoadFromJsonObject(JObject).) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| NewGuid | (Inherited from StiComponent.) |
| OnAfterPrint |
Raises the AfterPrint event.
(Inherited from StiComponent.) |
| OnBeforePrint |
Raises the BeforePrint event.
(Inherited from StiComponent.) |
| OnClick |
Raises the Click event for this report.
(Inherited from StiComponent.) |
| OnDoubleClick |
Raises the DoubleClick event for this report.
(Inherited from StiComponent.) |
| OnGetBookmark |
Raises the GetBookmark event.
(Inherited from StiComponent.) |
| OnGetDrillDownReport |
Raises the GetDrillDownReport event for this report.
(Inherited from StiComponent.) |
| OnGetHyperlink |
Raises the GetHyperlink event.
(Inherited from StiComponent.) |
| OnGetTag |
Raises the GetTag event.
(Inherited from StiComponent.) |
| OnGetToolTip |
Raises the GetToolTip event.
(Inherited from StiComponent.) |
| OnMouseEnter |
Raises the MouseEnter event for this report.
(Inherited from StiComponent.) |
| OnMouseLeave |
Raises the MouseLeave event for this report.
(Inherited from StiComponent.) |
| OnPainted |
Raises the Painted event for this component.
(Inherited from StiComponent.) |
| OnPainting |
Raises the Painting event for this component.
(Inherited from StiComponent.) |
| OnRemoveComponent | (Inherited from StiComponent.) |
| OnResizeComponent | (Inherited from StiComponent.) |
| PackService |
Packs a service.
(Inherited from StiComponent.) |
| PageToComponent(PointD) |
Converts a point from coordinates of a page into the parent-container coordinates.
The method calls the PageToContainer method of the parent component.
(Inherited from StiComponent.) |
| PageToComponent(RectangleD) |
Converts a rectangle from coordinates of a page into the parent-container coordinates.
The method calls the PageToContainer method of the parent component.
(Inherited from StiComponent.) |
| Paint |
Paints a component.
(Inherited from StiComponent.) |
| PaintEvents |
Paints events of a component.
(Inherited from StiComponent.) |
| PaintHighlight |
Paints the highlight of the component.
(Inherited from StiComponent.) |
| PaintMarkers |
Paints a markers specified by a Rectangle structure. This method can be used only in win version.
(Inherited from StiComponent.) |
| PaintSelection |
Paints the selection of the component.
(Inherited from StiComponent.) |
| PlacedOnColumnBand |
Specifies whether it is possible to place the component on the ColumnBand.
(Inherited from StiComponent.) |
| Prepare |
Prepare content for rendering.
(Inherited from StiComponent.) |
| RemoveSeries | |
| RemoveTarget | |
| RemoveValue | |
| Render | (Inherited from StiComponent.) |
| Render(StiContainer) |
Renders a component in the specified container with events generation.
(Inherited from StiComponent.) |
| Render(StiComponent, StiContainer) |
Renders a component in the specified container with events generation.
The rendered component will return in 'renderedComponent' argument.
(Inherited from StiComponent.) |
| RenderComponent |
Renders a component in the specified container without generation of the 'BeforePrintEvent' event and the 'AfterPrintEvent' event and
without checking Conditions. The rendered component will return in 'renderedComponent' argument.
This is backward compatibility method. Please use InternalRender method for new developed components.
(Inherited from StiComponent.) |
| Reset |
Reset selection of component.
(Inherited from StiComponent.) |
| RestoreState |
Restores the earlier saved object state.
(Inherited from StiComponent.) |
| RetrieveUsedDataNames | (Overrides StiElementRetrieveUsedDataNames.) |
| RetrieveUsedDataNames(String) | (Inherited from StiElement.) |
| SaveState |
Saves the current state of an object.
(Inherited from StiComponent.) |
| SaveToJsonObject | (Overrides StiElementSaveToJsonObject(StiJsonSaveMode).) |
| Select |
Select component.
(Inherited from StiComponent.) |
| SetDirectDisplayRectangle | (Inherited from StiComponent.) |
| SetPaintRectangle |
Internal use only.
(Inherited from StiComponent.) |
| SetReportVariables | (Inherited from StiComponent.) |
| ToString |
Returns an Name of the component and/or the Alias of the component.
(Inherited from StiComponent.) |
| ToString(Boolean) | (Inherited from StiComponent.) |
| UnPrepare |
Clear component afrer render.
(Inherited from StiComponent.) |
Events| Name | Description | |
|---|---|---|
 | AfterPrint |
Occurs after the component printing.
(Inherited from StiComponent.) |
| BeforePrint |
Occurs before printing of the component.
(Inherited from StiComponent.) |
| Click |
Occurs when user clicks on the component in the window of viewer.
(Inherited from StiComponent.) |
| DoubleClick |
Occurs when user double clicks on the component in the window of viewer.
(Inherited from StiComponent.) |
| GetBookmark |
Occurs when getting of the Bookmark for the component.
(Inherited from StiComponent.) |
| GetDrillDownReport |
Occurs when it is required to get a report for the Drill-Down operation.
(Inherited from StiComponent.) |
| GetHyperlink |
Occurs when getting Hyperlink for the component.
(Inherited from StiComponent.) |
| GetTag |
Occurs when getting a Tag for a component.
(Inherited from StiComponent.) |
| GetToolTip |
Occurs when getting the ToolTip for the component.
(Inherited from StiComponent.) |
| MouseEnter |
Occurs when user enters the mouse into the area of the component in the window of viewer.
(Inherited from StiComponent.) |
| MouseLeave |
Occurs when user leaves the mouse out of the area of the component in the window of viewer.
(Inherited from StiComponent.) |
| Painted |
Occurs after the component was painted.
(Inherited from StiComponent.) |
| Painting |
Occurs before the component painting.
(Inherited from StiComponent.) |
See Also