Click or drag to resize

StiElement Class

Describes the base class for all dashboards elements.
Inheritance Hierarchy

Namespace:  Stimulsoft.Dashboard.Components
Assembly:  Stimulsoft.Dashboard (in Stimulsoft.Dashboard.dll) Version: 2019.3.1.0
Syntax
public abstract class StiElement : StiComponent, 
	IStiElement, IStiReportComponent, IStiAppComponent, IStiAppCell, IStiRetrieval, 
	IStiSimpleBorder, IStiBackColor, IStiPadding, IStiMargin

The StiElement type exposes the following members.

Constructors
  NameDescription
Public methodStiElement
Creates a new StiElement.
Public methodStiElement(RectangleD)
Creates a new StiElement.
Top
Properties
  NameDescription
Public propertyAfterPrintEvent (Overrides StiComponentAfterPrintEvent.)
Public propertyAlias
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.)
Public propertyAllowDelete
Gets a value which indicates whether deleting of the components is allowed.
(Inherited from StiComponent.)
Public propertyAnchor (Overrides StiComponentAnchor.)
Public propertyBackColor
Gets or sets a back color.
Public propertyBeforePrintEvent (Overrides StiComponentBeforePrintEvent.)
Public propertyBookmark (Overrides StiComponentBookmark.)
Public propertyBookmarkValue
Gets or sets the component bookmark.
(Inherited from StiComponent.)
Public propertyBorder
Gets or sets border of the element.
Public propertyBottom
Gets bottom position of a component.
(Inherited from StiComponent.)
Public propertyCanGrow (Overrides StiComponentCanGrow.)
Public propertyCanShrink (Overrides StiComponentCanShrink.)
Public propertyClickEvent (Overrides StiComponentClickEvent.)
Public propertyClientRectangle
Gets or sets the client area of a component.
(Inherited from StiComponent.)
Public propertyComponentId (Inherited from StiComponent.)
Public propertyComponentPlacement
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.)
Public propertyComponentStyle (Overrides StiComponentComponentStyle.)
Public propertyComponentType
Gets the type of processing when printing.
(Inherited from StiComponent.)
Public propertyConditions (Overrides StiComponentConditions.)
Public propertyCurrentBookmark
Gets or sets current bookmark for this component.
(Inherited from StiComponent.)
Public propertyDashboard
Public propertyDefaultClientRectangle
Gets or sets the default client area of a component.
(Overrides StiComponentDefaultClientRectangle.)
Public propertyDelimiterComponent
Gets or sets a value indicates that this component is used as the delimiter.
(Inherited from StiComponent.)
Public propertyDisplayRectangle
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.)
Public propertyDockable
Gets or sets a value which indicates whether the component will be docked or not.
(Inherited from StiComponent.)
Public propertyDockStyle (Overrides StiComponentDockStyle.)
Public propertyDoubleClickEvent (Overrides StiComponentDoubleClickEvent.)
Public propertyDrillDownParameters (Inherited from StiComponent.)
Public propertyEnabled
Gets or sets a value which indicates will this component be available or not.
(Overrides StiComponentEnabled.)
Protected propertyEvents (Inherited from StiComponent.)
Public propertyForceRedrawAll
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.)
Public propertyGetBookmarkEvent (Overrides StiComponentGetBookmarkEvent.)
Public propertyGetDrillDownReportEvent (Overrides StiComponentGetDrillDownReportEvent.)
Public propertyGetHyperlinkEvent (Overrides StiComponentGetHyperlinkEvent.)
Public propertyGetTagEvent (Overrides StiComponentGetTagEvent.)
Public propertyGetToolTipEvent (Overrides StiComponentGetToolTipEvent.)
Public propertyGrowToHeight (Overrides StiComponentGrowToHeight.)
Public propertyGuid
Gets or sets a guid of component.
(Inherited from StiComponent.)
Public propertyHeight (Overrides StiComponentHeight.)
Public propertyHelpUrl (Inherited from StiComponent.)
Public propertyHighlightState
Gets or sets a state of highlight.
(Inherited from StiComponent.)
Public propertyHyperlink (Overrides StiComponentHyperlink.)
Public propertyHyperlinkValue
Gets or sets hyperlink of a component.
(Inherited from StiComponent.)
Public propertyIgnoreNamingRule
Internal use only.
(Inherited from StiComponent.)
Public propertyInherited (Inherited from StiComponent.)
Public propertyInteraction (Overrides StiComponentInteraction.)
Public propertyInvalidateOnMouseOver
Gets a value which indicates whether invalidating of the component occurs when a mouse pointer is above the component.
(Inherited from StiComponent.)
Public propertyIsAutomaticDock
Gets a value which indicates that this is an automatic docking.
(Inherited from StiComponent.)
Public propertyIsCross
Gets a value indicating that this is the Cross component.
(Inherited from StiComponent.)
Public propertyIsDefined
Public propertyIsDesigning
Gets a value which indicates that the report in which a component is placed is being designed.
(Inherited from StiComponent.)
Public propertyIsEnabled (Overrides StiComponentIsEnabled.)
Public propertyIsEventEmpty
Gets a value which indicates that all events are empty.
(Inherited from StiComponent.)
Public propertyIsExporting
Gets or sets value, which indicates that the report is exporting.
(Inherited from StiComponent.)
Public propertyIsPrinting
Gets a value which indicates that the component has already been printed.
(Inherited from StiComponent.)
Public propertyIsQuerable
Public propertyIsRendered
Gets or sets a value which indicates whether the component is rendered or not.
(Inherited from StiComponent.)
Public propertyIsSelected
Gets or sets value indicates is the component selected or not.
(Inherited from StiComponent.)
Public propertyKey
Public propertyLeft (Overrides StiComponentLeft.)
Public propertyLinked
Gets or sets a value which indicates whether the object snap to the container is turned on.
(Inherited from StiComponent.)
Public propertyLocalizedCategory
Gets a localized name of the component category.
(Overrides StiBaseLocalizedCategory.)
Public propertyLocalizedName
Gets a localized component name.
(Overrides StiBaseLocalizedName.)
Public propertyLocked
Gets or sets a value which indicates that moving is locked.
(Inherited from StiComponent.)
Public propertyMargin
Gets or sets element margin.
Public propertyMaxSize (Overrides StiComponentMaxSize.)
Public propertyMinSize (Overrides StiComponentMinSize.)
Public propertyMouseEnterEvent (Overrides StiComponentMouseEnterEvent.)
Public propertyMouseLeaveEvent (Overrides StiComponentMouseLeaveEvent.)
Public propertyName
Gets or sets a name of a component.
(Inherited from StiComponent.)
Public propertyPadding
Gets or sets element padding.
Public propertyPage
Gets or sets the page on which an object is located.
(Inherited from StiComponent.)
Public propertyParent
Gets or sets the container in which an object is located.
(Inherited from StiComponent.)
Public propertyParentBookmark
Gets or sets parent bookmark for this component.
(Inherited from StiComponent.)
Public propertyPlaceOnToolbox
Gets or sets a value which indicates whether it is necessary to place component in toolbox or not.
(Inherited from StiComponent.)
Public propertyPrintable (Overrides StiComponentPrintable.)
Public propertyPrintOn (Overrides StiComponentPrintOn.)
Public propertyPriority
Gets a component priority.
(Inherited from StiComponent.)
Public propertyProperties (Inherited from StiService.)
Public propertyPropName (Inherited from StiComponent.)
Public propertyRenderedCount
Gets or sets a value which indicates how many times the component is rendered.
(Inherited from StiComponent.)
Public propertyReport
Gets or sets the report in which the component is located.
(Inherited from StiComponent.)
Public propertyRestrictions
Gets or sets value which indicates the restrictions of a component.
(Inherited from StiComponent.)
Public propertyRight
Gets right position of a component.
(Inherited from StiComponent.)
Public propertySelectionTick (Inherited from StiComponent.)
Public propertySelectRectangle
Gets or sets a rectangle of a component selection.
(Inherited from StiComponent.)
Public propertyServiceCategory
Gets a service category.
(Overrides StiComponentServiceCategory.)
Public propertyServiceEnabled (Inherited from StiService.)
Public propertyServiceInfo (Inherited from StiService.)
Public propertyServiceName
Gets a service name.
(Inherited from StiBase.)
Public propertyServiceType
Gets a service type.
(Inherited from StiComponent.)
Public propertyShift
Gets or sets a value which indicates that this component can be shifted.
(Inherited from StiComponent.)
Public propertyShiftMode (Overrides StiComponentShiftMode.)
Public propertyShowQuickButtons
Gets or sets a value which indicates whether it is necessary to show quick buttons.
(Inherited from StiComponent.)
Protected propertyStates
Gets the component states manager.
(Inherited from StiComponent.)
Public propertyTag
Gets or sets the expression to fill a component tag.
(Inherited from StiComponent.)
Public propertyTagValue
Gets or sets tag of a component.
(Inherited from StiComponent.)
Public propertyToolboxCategory (Overrides StiComponentToolboxCategory.)
Public propertyToolboxPosition
Gets a value to sort a position in the toolbox.
(Inherited from StiComponent.)
Public propertyToolTip
Gets or sets the expression to fill a component tooltip.
(Inherited from StiComponent.)
Public propertyToolTipValue
Gets or sets a component tips.
(Inherited from StiComponent.)
Public propertyTop (Overrides StiComponentTop.)
Public propertyUseParentStyles (Overrides StiComponentUseParentStyles.)
Public propertyWidth (Overrides StiComponentWidth.)
Public propertyZoom
Top
Methods
  NameDescription
Public methodAddSize
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.)
Protected methodAllowPrintOn (Inherited from StiComponent.)
Public methodCanContainIn
May this container be located in the specified component.
(Overrides StiComponentCanContainIn(StiComponent).)
Public methodClearAllStates
Clears all earlier saved object states.
(Inherited from StiComponent.)
Public methodClearContents
Clears a text of all selected components.
(Inherited from StiComponent.)
Public methodClone
Creates a new object that is a copy of the current instance.
(Inherited from StiComponent.)
Public methodClone(Boolean)
Creates a new object that is a copy of the current instance.
(Overrides StiComponentClone(Boolean).)
Public methodComponentToPage(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.)
Public methodComponentToPage(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.)
Public methodComponentToPage(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.)
Public methodConvert (Overrides StiComponentConvert(StiUnit, StiUnit, Boolean).)
Public methodCreateNew (Inherited from StiComponent.)
Public methodDoBookmark
Invokes the GetBookmark event.
(Inherited from StiComponent.)
Public methodDockToContainer
Docks the component and all of its subordinate components.
(Inherited from StiComponent.)
Public methodDockToContainer(RectangleD)
Docks a rectangle, relatively to the component, into the rectangle.
(Inherited from StiComponent.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Public methodFetchAllMeters
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetActualSize
Initializes a new instance of the SizeD class from the specified dimensions.
(Inherited from StiComponent.)
Public methodGetContainer
Returns the topmost Container(StiPanel or StiPage) in which the component is located. Returns null, if nothing is located.
(Inherited from StiComponent.)
Public methodGetDataBand
Returns the DataBand in which the component is located. Returns null, if nothing is located.
(Inherited from StiComponent.)
Public methodGetDefaultEvent
Gets default event for this report control.
Public methodGetDictionary
Public methodGetDisplayRectangle
Returns a rectangle of the component showing.
(Inherited from StiComponent.)
Public methodGetDockRegion(StiComponent)
Retuns an empty rectangle to which docking is possible.
(Inherited from StiComponent.)
Public methodGetDockRegion(StiComponent, Boolean)
Retuns an empty rectangle to which docking is possible.
(Inherited from StiComponent.)
Public methodGetEvents
Return events collection of this component;
(Overrides StiComponentGetEvents.)
Public methodGetEvents(IStiPropertyGrid) (Inherited from StiComponent.)
Public methodGetGroupHeaderBand
Returns the GroupHeaderBand in which the component is located. Returns null, if nothing is located.
(Inherited from StiComponent.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetLevel
Returns the level of the object nesting. Level 1 - page, 2 - page and etc.
(Inherited from StiComponent.)
Public methodGetMeasureGraphics (Inherited from StiComponent.)
Public methodGetMeters
Public methodGetNestedPages
Returns a list of the nested pages.
Public methodGetPaintRectangle
Makes all necessary coversions for showing an object and returns its coordinates.
(Inherited from StiComponent.)
Public methodGetPaintRectangle(Boolean, Boolean)
Makes all necessary conversions for the object output and returns its coordinates.
(Inherited from StiComponent.)
Public methodGetPaintRectangle(Boolean, Boolean, Boolean)
Makes all necessary conversions for the object output and returns its coordinates.
(Inherited from StiComponent.)
Public methodGetProperties (Inherited from StiComponent.)
Public methodGetQuickInfo (Inherited from StiComponent.)
Public methodGetReport (Inherited from StiComponent.)
Public methodGetThumbnail(Int32, Boolean)
Gets a thumbnail image of the component.
(Inherited from StiComponent.)
Public methodGetThumbnail(Int32, Int32)
Gets a thumbnail image of the component.
(Inherited from StiComponent.)
Public methodGetThumbnail(Int32, Int32, Boolean)
Gets a thumbnail image of the component.
(Inherited from StiComponent.)
Public methodGetThumbnailAsBytes
Gets a thumbnail image in the byte aray of the component.
(Inherited from StiComponent.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInternalRender (Inherited from StiComponent.)
Public methodInternalRender(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.)
Public methodInvert
Invert selection of component.
(Inherited from StiComponent.)
Public methodInvokeAfterPrint
Raises the AfterPrint event.
(Inherited from StiComponent.)
Public methodInvokeBeforePrint
Raises the BeforePrint event.
(Inherited from StiComponent.)
Public methodInvokeClick
Raises the Click event for this report.
(Inherited from StiComponent.)
Public methodInvokeDoubleClick
Raises the DoubleClick event for this report.
(Inherited from StiComponent.)
Public methodInvokeEvents
Invokes all events for this components.
(Inherited from StiComponent.)
Public methodInvokeGetBookmark
Raises the GetBookmark event.
(Inherited from StiComponent.)
Public methodInvokeGetDrillDownReport
Raises the GetDrillDownReport event for this report.
(Inherited from StiComponent.)
Public methodInvokeGetHyperlink
Raises the GetHyperlink event.
(Inherited from StiComponent.)
Public methodInvokeGetTag
Raises the GetTag event.
(Inherited from StiComponent.)
Public methodInvokeGetToolTip
Raises the GetToolTip event.
(Inherited from StiComponent.)
Public methodInvokeMouseEnter
Raises the MouseEnter event for this report.
(Inherited from StiComponent.)
Public methodInvokeMouseLeave
Raises the MouseLeave event for this report.
(Inherited from StiComponent.)
Public methodInvokePainted
Raises the Painted event for this component.
(Inherited from StiComponent.)
Public methodInvokePainting
Raises the Painting event for this component.
(Inherited from StiComponent.)
Public methodIsExportAsImage (Inherited from StiComponent.)
Protected methodIsPropertiesInitializedProtected (Inherited from StiService.)
Public methodIsPropertyPresent (Inherited from StiService.)
Public methodLoadFromJsonObject (Overrides StiComponentLoadFromJsonObject(JObject).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewGuid (Inherited from StiComponent.)
Protected methodOnAfterPrint
Raises the AfterPrint event.
(Inherited from StiComponent.)
Protected methodOnBeforePrint
Raises the BeforePrint event.
(Inherited from StiComponent.)
Protected methodOnClick
Raises the Click event for this report.
(Inherited from StiComponent.)
Protected methodOnDoubleClick
Raises the DoubleClick event for this report.
(Inherited from StiComponent.)
Protected methodOnGetBookmark
Raises the GetBookmark event.
(Inherited from StiComponent.)
Protected methodOnGetDrillDownReport
Raises the GetDrillDownReport event for this report.
(Inherited from StiComponent.)
Protected methodOnGetHyperlink
Raises the GetHyperlink event.
(Inherited from StiComponent.)
Protected methodOnGetTag
Raises the GetTag event.
(Inherited from StiComponent.)
Protected methodOnGetToolTip
Raises the GetToolTip event.
(Inherited from StiComponent.)
Protected methodOnMouseEnter
Raises the MouseEnter event for this report.
(Inherited from StiComponent.)
Protected methodOnMouseLeave
Raises the MouseLeave event for this report.
(Inherited from StiComponent.)
Protected methodOnPainted
Raises the Painted event for this component.
(Inherited from StiComponent.)
Protected methodOnPainting
Raises the Painting event for this component.
(Inherited from StiComponent.)
Public methodOnRemoveComponent (Inherited from StiComponent.)
Public methodOnResizeComponent (Inherited from StiComponent.)
Public methodPackService
Packs a service.
(Inherited from StiComponent.)
Public methodPageToComponent(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.)
Public methodPageToComponent(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.)
Public methodPaint
Paints a component.
(Inherited from StiComponent.)
Public methodPaintEvents
Paints events of a component.
(Inherited from StiComponent.)
Public methodPaintHighlight
Paints the highlight of the component.
(Inherited from StiComponent.)
Public methodPaintMarkers
Paints a markers specified by a Rectangle structure. This method can be used only in win version.
(Inherited from StiComponent.)
Public methodPaintSelection
Paints the selection of the component.
(Inherited from StiComponent.)
Public methodPlacedOnColumnBand
Specifies whether it is possible to place the component on the ColumnBand.
(Inherited from StiComponent.)
Public methodPrepare
Prepare content for rendering.
(Inherited from StiComponent.)
Public methodRender (Inherited from StiComponent.)
Public methodRender(StiContainer)
Renders a component in the specified container with events generation.
(Inherited from StiComponent.)
Public methodRender(StiComponent, StiContainer)
Renders a component in the specified container with events generation. The rendered component will return in 'renderedComponent' argument.
(Inherited from StiComponent.)
Protected methodRenderComponent
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.)
Public methodReset
Reset selection of component.
(Inherited from StiComponent.)
Public methodRestoreState
Restores the earlier saved object state.
(Inherited from StiComponent.)
Public methodRetrieveUsedDataNames
Public methodRetrieveUsedDataNames(String)
Public methodSaveState
Saves the current state of an object.
(Inherited from StiComponent.)
Public methodSaveToJsonObject (Overrides StiComponentSaveToJsonObject(StiJsonSaveMode).)
Public methodSelect
Select component.
(Inherited from StiComponent.)
Protected methodSetDirectDisplayRectangle (Inherited from StiComponent.)
Public methodSetPaintRectangle
Internal use only.
(Inherited from StiComponent.)
Public methodSetReportVariables (Inherited from StiComponent.)
Public methodToString
Returns an Name of the component and/or the Alias of the component.
(Inherited from StiComponent.)
Public methodToString(Boolean) (Inherited from StiComponent.)
Public methodUnPrepare
Clear component afrer render.
(Inherited from StiComponent.)
Top
Events
  NameDescription
Public eventAfterPrint
Occurs after the component printing.
(Inherited from StiComponent.)
Public eventBeforePrint
Occurs before printing of the component.
(Inherited from StiComponent.)
Public eventClick
Occurs when user clicks on the component in the window of viewer.
(Inherited from StiComponent.)
Public eventDoubleClick
Occurs when user double clicks on the component in the window of viewer.
(Inherited from StiComponent.)
Public eventGetBookmark
Occurs when getting of the Bookmark for the component.
(Inherited from StiComponent.)
Public eventGetDrillDownReport
Occurs when it is required to get a report for the Drill-Down operation.
(Inherited from StiComponent.)
Public eventGetHyperlink
Occurs when getting Hyperlink for the component.
(Inherited from StiComponent.)
Public eventGetTag
Occurs when getting a Tag for a component.
(Inherited from StiComponent.)
Public eventGetToolTip
Occurs when getting the ToolTip for the component.
(Inherited from StiComponent.)
Public eventMouseEnter
Occurs when user enters the mouse into the area of the component in the window of viewer.
(Inherited from StiComponent.)
Public eventMouseLeave
Occurs when user leaves the mouse out of the area of the component in the window of viewer.
(Inherited from StiComponent.)
Public eventPainted
Occurs after the component was painted.
(Inherited from StiComponent.)
Public eventPainting
Occurs before the component painting.
(Inherited from StiComponent.)
Top
See Also
Inheritance Hierarchy
SystemObject
  Stimulsoft.Base.ServicesStiService
    Stimulsoft.ReportStiBase
      Stimulsoft.Report.ComponentsStiComponent
        Stimulsoft.Dashboard.ComponentsStiElement
          Stimulsoft.Dashboard.Components.ChartStiChartElement
          Stimulsoft.Dashboard.Components.ComboBoxStiComboBoxElement
          Stimulsoft.Dashboard.Components.DatePickerStiDatePickerElement
          Stimulsoft.Dashboard.Components.GaugeStiGaugeElement
          Stimulsoft.Dashboard.Components.ImageStiImageElement
          Stimulsoft.Dashboard.Components.IndicatorStiIndicatorElement
          Stimulsoft.Dashboard.Components.ListBoxStiListBoxElement
          Stimulsoft.Dashboard.Components.OnlineMapStiOnlineMapElement
          Stimulsoft.Dashboard.Components.PivotTableStiPivotTableElement
          Stimulsoft.Dashboard.Components.ProgressStiProgressElement
          Stimulsoft.Dashboard.Components.RegionMapStiRegionMapElement
          Stimulsoft.Dashboard.Components.ShapeStiShapeElement
          Stimulsoft.Dashboard.Components.TableStiTableElement
          Stimulsoft.Dashboard.Components.TextStiTextElement
          Stimulsoft.Dashboard.Components.TreeViewStiTreeViewElement
          Stimulsoft.Dashboard.Components.TreeViewBoxStiTreeViewBoxElement