Click or drag to resize

StiComponent Class

Describes the base class for all components.
Inheritance Hierarchy

Namespace:  Stimulsoft.Report.Components
Assembly:  Stimulsoft.Report (in Stimulsoft.Report.dll) Version: 2019.3.1.0
Syntax
public abstract class StiComponent : StiBase, 
	IStiReportComponent, IStiAppComponent, IStiAppCell, IStiComponentGuid, IStiCanGrow, 
	IStiCanShrink, IStiUnitConvert, IStiShift, IStiGrowToHeight, IStiAnchor, 
	IStiConditions, IStiPrintOn, IStiInherited, IStiReportProperty, IStiInteraction, 
	IStiStateSaveRestore, IStiSelect, IStiPropertyGridObject, IStiJsonReportObject

The StiComponent type exposes the following members.

Constructors
  NameDescription
Public methodStiComponent
Creates a new component of the StiComponent type.
Public methodStiComponent(RectangleD)
Creates a new component of the type StiComponent with the specified location.
Top
Properties
  NameDescription
Public propertyAfterPrintEvent
Occurs after the component printing.
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.
Public propertyAllowDelete
Gets a value which indicates whether deleting of the components is allowed.
Public propertyAnchor
Gets or sets a value which indicates the mode of linking component location to the parent component size.
Public propertyBeforePrintEvent
Occurs before printing of the component.
Public propertyBookmark
Gets or sets the expression to fill a component bookmark.
Public propertyBookmarkValue
Gets or sets the component bookmark.
Public propertyBottom
Gets bottom position of a component.
Public propertyCanGrow
Gets or sets a value which indicates that this object can grow.
Public propertyCanShrink
Gets or sets value which indicates that this object can shrink.
Public propertyClickEvent
Occurs when user clicks on the component in the window of viewer.
Public propertyClientRectangle
Gets or sets the client area of a component.
Public propertyComponentId
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
Public propertyComponentStyle
Gets or sets a style of a component.
Public propertyComponentType
Gets the type of processing when printing.
Public propertyConditions
Gets or sets the collection of conditions.
Public propertyCurrentBookmark
Gets or sets current bookmark for this component.
Public propertyDefaultClientRectangle
Gets the default client area of a component.
Public propertyDelimiterComponent
Gets or sets a value indicates that this component is used as the delimiter.
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).
Public propertyDockable
Gets or sets a value which indicates whether the component will be docked or not.
Public propertyDockStyle
Gets or sets a type of the component docking.
Public propertyDoubleClickEvent
Occurs when user double clicks on the component in the window of viewer.
Public propertyDrillDownParameters
Public propertyEnabled
Gets or sets a value which indicates will this component be available or not.
Protected propertyEvents
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.
Public propertyGetBookmarkEvent
Occurs when getting of the Bookmark for the component.
Public propertyGetDrillDownReportEvent
Occurs when it is required to get a report for the Drill-Down operation.
Public propertyGetHyperlinkEvent
Occurs when getting Hyperlink for the component.
Public propertyGetTagEvent
Occurs when getting a Tag for a component.
Public propertyGetToolTipEvent
Occurs when getting the ToolTip for the component.
Public propertyGrowToHeight
Gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
Public propertyGuid
Gets or sets a guid of component.
Public propertyHeight
Gets or sets height of a component.
Public propertyHelpUrl
Public propertyHighlightState
Gets or sets a state of highlight.
Public propertyHyperlink
Gets or sets an expression to fill a component hyperlink.
Public propertyHyperlinkValue
Gets or sets hyperlink of a component.
Public propertyIgnoreNamingRule
Internal use only.
Public propertyInherited
Public propertyInteraction
Gets interaction options of this component.
Public propertyInvalidateOnMouseOver
Gets a value which indicates whether invalidating of the component occurs when a mouse pointer is above the component.
Public propertyIsAutomaticDock
Gets a value which indicates that this is an automatic docking.
Public propertyIsCross
Gets a value indicating that this is the Cross component.
Public propertyIsDesigning
Gets a value which indicates that the report in which a component is placed is being designed.
Public propertyIsEnabled
Public propertyIsEventEmpty
Gets a value which indicates that all events are empty.
Public propertyIsExporting
Gets or sets value, which indicates that the report is exporting.
Public propertyIsPrinting
Gets a value which indicates that the component has already been printed.
Public propertyIsRendered
Gets or sets a value which indicates whether the component is rendered or not.
Public propertyIsSelected
Gets or sets value indicates is the component selected or not.
Public propertyLeft
Gets or sets left position of a component.
Public propertyLinked
Gets or sets a value which indicates whether the object snap to the container is turned on.
Public propertyLocalizedCategory
Gets a localized name of the component category.
(Inherited from StiBase.)
Public propertyLocalizedName
Gets a localized component name.
(Inherited from StiBase.)
Public propertyLocked
Gets or sets a value which indicates that moving is locked.
Public propertyMaxSize
Gets or sets maximal size.
Public propertyMinSize
Gets or sets minimal size.
Public propertyMouseEnterEvent
Occurs when user enters the mouse into the area of the component in the window of viewer.
Public propertyMouseLeaveEvent
Occurs when user leaves the mouse out of the area of the component in the window of viewer.
Public propertyName
Gets or sets a name of a component.
(Overrides StiBaseName.)
Public propertyPage
Gets or sets the page on which an object is located.
Public propertyParent
Gets or sets the container in which an object is located.
Public propertyParentBookmark
Gets or sets parent bookmark for this component.
Public propertyPlaceOnToolbox
Gets or sets a value which indicates whether it is necessary to place component in toolbox or not.
Public propertyPrintable
Gets or sets a value which indicates whether the component is printable or not.
Public propertyPrintOn
Gets or sets a value which indicates on what pages component will be printed.
Public propertyPriority
Gets a component priority.
Public propertyProperties (Inherited from StiService.)
Public propertyPropName
Public propertyRenderedCount
Gets or sets a value which indicates how many times the component is rendered.
Public propertyReport
Gets or sets the report in which the component is located.
Public propertyRestrictions
Gets or sets value which indicates the restrictions of a component.
Public propertyRight
Gets right position of a component.
Public propertySelectionTick
Public propertySelectRectangle
Gets or sets a rectangle of a component selection.
Public propertyServiceCategory
Gets a category of services.
(Overrides StiServiceServiceCategory.)
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.
(Overrides StiServiceServiceType.)
Public propertyShift
Gets or sets a value which indicates that this component can be shifted.
Public propertyShiftMode
Gets or sets a value which indicates the shift mode of the component.
Public propertyShowQuickButtons
Gets or sets a value which indicates whether it is necessary to show quick buttons.
Protected propertyStates
Gets the component states manager.
Public propertyTag
Gets or sets the expression to fill a component tag.
Public propertyTagValue
Gets or sets tag of a component.
Public propertyToolboxCategory
Public propertyToolboxPosition
Gets a value to sort a position in the toolbox.
Public propertyToolTip
Gets or sets the expression to fill a component tooltip.
Public propertyToolTipValue
Gets or sets a component tips.
Public propertyTop
Gets or sets top position of a component.
Public propertyUseParentStyles
Gets or sets a value which indicates that this component must use styles from parent component.
Public propertyWidth
Gets or sets width of a component.
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.
Protected methodAllowPrintOn
Public methodCanContainIn
Specifies that this component may be located in the specified component.
Public methodClearAllStates
Clears all earlier saved object states.
Public methodClearContents
Clears a text of all selected components.
Public methodClone
Creates a new object that is a copy of the current instance.
(Overrides StiServiceClone.)
Public methodClone(Boolean)
Creates a new object that is a copy of the current instance.
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.
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.
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.
Public methodConvert
Converts a component out of one unit into another.
Public methodStatic memberConvertDock
Public methodStatic memberConvertDockStyle
Public methodCreateNew
Public methodDoBookmark
Invokes the GetBookmark event.
Public methodDockToContainer
Docks the component and all of its subordinate components.
Public methodDockToContainer(RectangleD)
Docks a rectangle, relatively to the component, into the rectangle.
Public methodStatic memberDoOffsetRect
Moves a rectangle to the specified offset.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
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.
Public methodGetContainer
Returns the topmost Container(StiPanel or StiPage) in which the component is located. Returns null, if nothing is located.
Public methodGetDataBand
Returns the DataBand in which the component is located. Returns null, if nothing is located.
Public methodGetDisplayRectangle
Returns a rectangle of the component showing.
Public methodGetDockRegion(StiComponent)
Retuns an empty rectangle to which docking is possible.
Public methodGetDockRegion(StiComponent, Boolean)
Retuns an empty rectangle to which docking is possible.
Public methodGetEvents
Returns events collection of this component.
Public methodGetEvents(IStiPropertyGrid)
Public methodGetGroupHeaderBand
Returns the GroupHeaderBand in which the component is located. Returns null, if nothing is located.
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.
Public methodGetMeasureGraphics
Public methodGetPaintRectangle
Makes all necessary coversions for showing an object and returns its coordinates.
Public methodGetPaintRectangle(Boolean, Boolean)
Makes all necessary conversions for the object output and returns its coordinates.
Public methodGetPaintRectangle(Boolean, Boolean, Boolean)
Makes all necessary conversions for the object output and returns its coordinates.
Public methodGetProperties
Public methodGetQuickInfo
Public methodGetReport
Public methodGetThumbnail(Int32, Boolean)
Gets a thumbnail image of the component.
Public methodGetThumbnail(Int32, Int32)
Gets a thumbnail image of the component.
Public methodGetThumbnail(Int32, Int32, Boolean)
Gets a thumbnail image of the component.
Public methodGetThumbnailAsBytes
Gets a thumbnail image in the byte aray of the component.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInternalRender
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.
Public methodInvert
Invert selection of component.
Public methodInvokeAfterPrint
Raises the AfterPrint event.
Public methodInvokeBeforePrint
Raises the BeforePrint event.
Public methodInvokeClick
Raises the Click event for this report.
Public methodInvokeDoubleClick
Raises the DoubleClick event for this report.
Public methodInvokeEvents
Invokes all events for this components.
Public methodInvokeGetBookmark
Raises the GetBookmark event.
Public methodInvokeGetDrillDownReport
Raises the GetDrillDownReport event for this report.
Public methodInvokeGetHyperlink
Raises the GetHyperlink event.
Public methodInvokeGetTag
Raises the GetTag event.
Public methodInvokeGetToolTip
Raises the GetToolTip event.
Public methodInvokeMouseEnter
Raises the MouseEnter event for this report.
Public methodInvokeMouseLeave
Raises the MouseLeave event for this report.
Public methodInvokePainted
Raises the Painted event for this component.
Public methodInvokePainting
Raises the Painting event for this component.
Public methodIsExportAsImage
Public methodStatic memberIsParentSelect
Retuns true if one of the parent component is selected.
Protected methodIsPropertiesInitializedProtected (Inherited from StiService.)
Public methodIsPropertyPresent (Inherited from StiService.)
Public methodLoadFromJsonObject
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodNewGuid
Protected methodOnAfterPrint
Raises the AfterPrint event.
Protected methodOnBeforePrint
Raises the BeforePrint event.
Protected methodOnClick
Raises the Click event for this report.
Protected methodOnDoubleClick
Raises the DoubleClick event for this report.
Protected methodOnGetBookmark
Raises the GetBookmark event.
Protected methodOnGetDrillDownReport
Raises the GetDrillDownReport event for this report.
Protected methodOnGetHyperlink
Raises the GetHyperlink event.
Protected methodOnGetTag
Raises the GetTag event.
Protected methodOnGetToolTip
Raises the GetToolTip event.
Protected methodOnMouseEnter
Raises the MouseEnter event for this report.
Protected methodOnMouseLeave
Raises the MouseLeave event for this report.
Protected methodOnPainted
Raises the Painted event for this component.
Protected methodOnPainting
Raises the Painting event for this component.
Public methodOnRemoveComponent
Public methodOnResizeComponent
Public methodPackService
Packs a service.
(Overrides StiServicePackService.)
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.
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.
Public methodPaint
Paints a component.
Public methodPaintEvents
Paints events of a component.
Public methodPaintHighlight
Paints the highlight of the component.
Public methodPaintMarkers
Paints a markers specified by a Rectangle structure. This method can be used only in win version.
Public methodPaintSelection
Paints the selection of the component.
Public methodPlacedOnColumnBand
Specifies whether it is possible to place the component on the ColumnBand.
Public methodPrepare
Prepare content for rendering.
Public methodRender
Public methodRender(StiContainer)
Renders a component in the specified container with events generation.
Public methodRender(StiComponent, StiContainer)
Renders a component in the specified container with events generation. The rendered component will return in 'renderedComponent' argument.
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.
Public methodReset
Reset selection of component.
Public methodRestoreState
Restores the earlier saved object state.
Public methodSaveState
Saves the current state of an object.
Public methodSaveToJsonObject
Public methodSelect
Select component.
Protected methodSetDirectDisplayRectangle
Public methodSetPaintRectangle
Internal use only.
Public methodSetReportVariables
Public methodToString
Returns an Name of the component and/or the Alias of the component.
(Overrides ObjectToString.)
Public methodToString(Boolean)
Public methodUnPrepare
Clear component afrer render.
Top
Events
  NameDescription
Public eventAfterPrint
Occurs after the component printing.
Public eventBeforePrint
Occurs before printing of the component.
Public eventClick
Occurs when user clicks on the component in the window of viewer.
Public eventDoubleClick
Occurs when user double clicks on the component in the window of viewer.
Public eventGetBookmark
Occurs when getting of the Bookmark for the component.
Public eventGetDrillDownReport
Occurs when it is required to get a report for the Drill-Down operation.
Public eventGetHyperlink
Occurs when getting Hyperlink for the component.
Public eventGetTag
Occurs when getting a Tag for a component.
Public eventGetToolTip
Occurs when getting the ToolTip for the component.
Public eventMouseEnter
Occurs when user enters the mouse into the area of the component in the window of viewer.
Public eventMouseLeave
Occurs when user leaves the mouse out of the area of the component in the window of viewer.
Public eventPainted
Occurs after the component was painted.
Public eventPainting
Occurs before the component painting.
Top
Fields
See Also
Inheritance Hierarchy
SystemObject
  Stimulsoft.Base.ServicesStiService
    Stimulsoft.ReportStiBase
      Stimulsoft.Report.ComponentsStiComponent
        Stimulsoft.Dashboard.ComponentsStiElement
        Stimulsoft.Report.BarCodesStiBarCode
        Stimulsoft.Report.ChartStiChart
        Stimulsoft.Report.ComponentsStiCheckBox
        Stimulsoft.Report.ComponentsStiContainer
        Stimulsoft.Report.ComponentsStiPrimitive
        Stimulsoft.Report.ComponentsStiShape
        Stimulsoft.Report.ComponentsStiSimpleText
        Stimulsoft.Report.ComponentsStiUndefinedComponent
        Stimulsoft.Report.ComponentsStiView
        Stimulsoft.Report.ComponentsStiWinControl
        Stimulsoft.Report.ComponentsStiZipCode
        Stimulsoft.Report.GaugeStiGauge
        Stimulsoft.Report.MapsStiMap