StiComponent Class |
Namespace: Stimulsoft.Report.Components
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.
Name | Description | |
---|---|---|
StiComponent |
Creates a new component of the StiComponent type.
| |
StiComponent(RectangleD) |
Creates a new component of the type StiComponent with the specified location.
|
Name | Description | |
---|---|---|
AfterPrintEvent |
Occurs after the component printing.
| |
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.
| |
AllowDelete |
Gets a value which indicates whether deleting of the components is allowed.
| |
Anchor |
Gets or sets a value which indicates the mode of linking component location to the parent component size.
| |
BeforePrintEvent |
Occurs before printing of the component.
| |
Bookmark |
Gets or sets the expression to fill a component bookmark.
| |
BookmarkValue |
Gets or sets the component bookmark.
| |
Bottom |
Gets bottom position of a component.
| |
CanGrow |
Gets or sets a value which indicates that this object can grow.
| |
CanShrink |
Gets or sets value which indicates that this object can shrink.
| |
ClickEvent |
Occurs when user clicks on the component in the window of viewer.
| |
ClientRectangle |
Gets or sets the client area of a component.
| |
ComponentId | ||
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
| |
ComponentStyle |
Gets or sets a style of a component.
| |
ComponentType |
Gets the type of processing when printing.
| |
Conditions |
Gets or sets the collection of conditions.
| |
CurrentBookmark |
Gets or sets current bookmark for this component.
| |
DefaultClientRectangle |
Gets the default client area of a component.
| |
DelimiterComponent |
Gets or sets a value indicates that this component is used as the delimiter.
| |
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).
| |
Dockable |
Gets or sets a value which indicates whether the component will be docked or not.
| |
DockStyle |
Gets or sets a type of the component docking.
| |
DoubleClickEvent |
Occurs when user double clicks on the component in the window of viewer.
| |
DrillDownParameters | ||
Enabled |
Gets or sets a value which indicates will this component be available or not.
| |
Events | ||
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.
| |
GetBookmarkEvent |
Occurs when getting of the Bookmark for the component.
| |
GetDrillDownReportEvent |
Occurs when it is required to get a report for the Drill-Down operation.
| |
GetHyperlinkEvent |
Occurs when getting Hyperlink for the component.
| |
GetTagEvent |
Occurs when getting a Tag for a component.
| |
GetToolTipEvent |
Occurs when getting the ToolTip for the component.
| |
GrowToHeight |
Gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.
| |
Guid |
Gets or sets a guid of component.
| |
Height |
Gets or sets height of a component.
| |
HelpUrl | ||
HighlightState |
Gets or sets a state of highlight.
| |
Hyperlink |
Gets or sets an expression to fill a component hyperlink.
| |
HyperlinkValue |
Gets or sets hyperlink of a component.
| |
IgnoreNamingRule |
Internal use only.
| |
Inherited | ||
Interaction |
Gets interaction options of this component.
| |
InvalidateOnMouseOver |
Gets a value which indicates whether invalidating of the component occurs when a mouse pointer is above the component.
| |
IsAutomaticDock |
Gets a value which indicates that this is an automatic docking.
| |
IsCross |
Gets a value indicating that this is the Cross component.
| |
IsDesigning |
Gets a value which indicates that the report in which a component is placed is being designed.
| |
IsEnabled | ||
IsEventEmpty |
Gets a value which indicates that all events are empty.
| |
IsExporting |
Gets or sets value, which indicates that the report is exporting.
| |
IsPrinting |
Gets a value which indicates that the component has already been printed.
| |
IsRendered |
Gets or sets a value which indicates whether the component is rendered or not.
| |
IsSelected |
Gets or sets value indicates is the component selected or not.
| |
Left |
Gets or sets left position of a component.
| |
Linked |
Gets or sets a value which indicates whether the object snap to the container is turned on.
| |
LocalizedCategory |
Gets a localized name of the component category.
(Inherited from StiBase.) | |
LocalizedName |
Gets a localized component name.
(Inherited from StiBase.) | |
Locked |
Gets or sets a value which indicates that moving is locked.
| |
MaxSize |
Gets or sets maximal size.
| |
MinSize |
Gets or sets minimal size.
| |
MouseEnterEvent |
Occurs when user enters the mouse into the area of the component in the window of viewer.
| |
MouseLeaveEvent |
Occurs when user leaves the mouse out of the area of the component in the window of viewer.
| |
Name |
Gets or sets a name of a component.
(Overrides StiBaseName.) | |
Page |
Gets or sets the page on which an object is located.
| |
Parent |
Gets or sets the container in which an object is located.
| |
ParentBookmark |
Gets or sets parent bookmark for this component.
| |
PlaceOnToolbox |
Gets or sets a value which indicates whether it is necessary to place component in toolbox or not.
| |
Printable |
Gets or sets a value which indicates whether the component is printable or not.
| |
PrintOn |
Gets or sets a value which indicates on what pages component will be printed.
| |
Priority |
Gets a component priority.
| |
Properties | (Inherited from StiService.) | |
PropName | ||
RenderedCount |
Gets or sets a value which indicates how many times the component is rendered.
| |
Report |
Gets or sets the report in which the component is located.
| |
Restrictions |
Gets or sets value which indicates the restrictions of a component.
| |
Right |
Gets right position of a component.
| |
SelectionTick | ||
SelectRectangle |
Gets or sets a rectangle of a component selection.
| |
ServiceCategory |
Gets a category of services.
(Overrides StiServiceServiceCategory.) | |
ServiceEnabled | (Inherited from StiService.) | |
ServiceInfo | (Inherited from StiService.) | |
ServiceName |
Gets a service name.
(Inherited from StiBase.) | |
ServiceType |
Gets a service type.
(Overrides StiServiceServiceType.) | |
Shift |
Gets or sets a value which indicates that this component can be shifted.
| |
ShiftMode |
Gets or sets a value which indicates the shift mode of the component.
| |
ShowQuickButtons |
Gets or sets a value which indicates whether it is necessary to show quick buttons.
| |
States |
Gets the component states manager.
| |
Tag |
Gets or sets the expression to fill a component tag.
| |
TagValue |
Gets or sets tag of a component.
| |
ToolboxCategory | ||
ToolboxPosition |
Gets a value to sort a position in the toolbox.
| |
ToolTip |
Gets or sets the expression to fill a component tooltip.
| |
ToolTipValue |
Gets or sets a component tips.
| |
Top |
Gets or sets top position of a component.
| |
UseParentStyles |
Gets or sets a value which indicates that this component must use styles from parent component.
| |
Width |
Gets or sets width of a component.
|
Name | Description | |
---|---|---|
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.
| |
AllowPrintOn | ||
CanContainIn |
Specifies that this component may be located in the specified component.
| |
ClearAllStates |
Clears all earlier saved object states.
| |
ClearContents |
Clears a text of all selected components.
| |
Clone |
Creates a new object that is a copy of the current instance.
(Overrides StiServiceClone.) | |
Clone(Boolean) |
Creates a new object that is a copy of the current instance.
| |
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.
| |
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.
| |
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.
| |
Convert |
Converts a component out of one unit into another.
| |
ConvertDock | ||
ConvertDockStyle | ||
CreateNew | ||
DoBookmark |
Invokes the GetBookmark event.
| |
DockToContainer |
Docks the component and all of its subordinate components.
| |
DockToContainer(RectangleD) |
Docks a rectangle, relatively to the component, into the rectangle.
| |
DoOffsetRect |
Moves a rectangle to the specified offset.
| |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) | |
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.
| |
GetContainer |
Returns the topmost Container(StiPanel or StiPage) in which the component is located.
Returns null, if nothing is located.
| |
GetDataBand |
Returns the DataBand in which the component is located.
Returns null, if nothing is located.
| |
GetDisplayRectangle |
Returns a rectangle of the component showing.
| |
GetDockRegion(StiComponent) |
Retuns an empty rectangle to which docking is possible.
| |
GetDockRegion(StiComponent, Boolean) |
Retuns an empty rectangle to which docking is possible.
| |
GetEvents |
Returns events collection of this component.
| |
GetEvents(IStiPropertyGrid) | ||
GetGroupHeaderBand |
Returns the GroupHeaderBand in which the component is located.
Returns null, if nothing is located.
| |
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.
| |
GetMeasureGraphics | ||
GetPaintRectangle |
Makes all necessary coversions for showing an object and returns its coordinates.
| |
GetPaintRectangle(Boolean, Boolean) |
Makes all necessary conversions for the object output and returns its coordinates.
| |
GetPaintRectangle(Boolean, Boolean, Boolean) |
Makes all necessary conversions for the object output and returns its coordinates.
| |
GetProperties | ||
GetQuickInfo | ||
GetReport | ||
GetThumbnail(Int32, Boolean) |
Gets a thumbnail image of the component.
| |
GetThumbnail(Int32, Int32) |
Gets a thumbnail image of the component.
| |
GetThumbnail(Int32, Int32, Boolean) |
Gets a thumbnail image of the component.
| |
GetThumbnailAsBytes |
Gets a thumbnail image in the byte aray of the component.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
InternalRender | ||
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.
| |
Invert |
Invert selection of component.
| |
InvokeAfterPrint |
Raises the AfterPrint event.
| |
InvokeBeforePrint |
Raises the BeforePrint event.
| |
InvokeClick |
Raises the Click event for this report.
| |
InvokeDoubleClick |
Raises the DoubleClick event for this report.
| |
InvokeEvents |
Invokes all events for this components.
| |
InvokeGetBookmark |
Raises the GetBookmark event.
| |
InvokeGetDrillDownReport |
Raises the GetDrillDownReport event for this report.
| |
InvokeGetHyperlink |
Raises the GetHyperlink event.
| |
InvokeGetTag |
Raises the GetTag event.
| |
InvokeGetToolTip |
Raises the GetToolTip event.
| |
InvokeMouseEnter |
Raises the MouseEnter event for this report.
| |
InvokeMouseLeave |
Raises the MouseLeave event for this report.
| |
InvokePainted |
Raises the Painted event for this component.
| |
InvokePainting |
Raises the Painting event for this component.
| |
IsExportAsImage | ||
IsParentSelect |
Retuns true if one of the parent component is selected.
| |
IsPropertiesInitializedProtected | (Inherited from StiService.) | |
IsPropertyPresent | (Inherited from StiService.) | |
LoadFromJsonObject | ||
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
NewGuid | ||
OnAfterPrint |
Raises the AfterPrint event.
| |
OnBeforePrint |
Raises the BeforePrint event.
| |
OnClick |
Raises the Click event for this report.
| |
OnDoubleClick |
Raises the DoubleClick event for this report.
| |
OnGetBookmark |
Raises the GetBookmark event.
| |
OnGetDrillDownReport |
Raises the GetDrillDownReport event for this report.
| |
OnGetHyperlink |
Raises the GetHyperlink event.
| |
OnGetTag |
Raises the GetTag event.
| |
OnGetToolTip |
Raises the GetToolTip event.
| |
OnMouseEnter |
Raises the MouseEnter event for this report.
| |
OnMouseLeave |
Raises the MouseLeave event for this report.
| |
OnPainted |
Raises the Painted event for this component.
| |
OnPainting |
Raises the Painting event for this component.
| |
OnRemoveComponent | ||
OnResizeComponent | ||
PackService |
Packs a service.
(Overrides StiServicePackService.) | |
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.
| |
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.
| |
Paint |
Paints a component.
| |
PaintEvents |
Paints events of a component.
| |
PaintHighlight |
Paints the highlight of the component.
| |
PaintMarkers |
Paints a markers specified by a Rectangle structure. This method can be used only in win version.
| |
PaintSelection |
Paints the selection of the component.
| |
PlacedOnColumnBand |
Specifies whether it is possible to place the component on the ColumnBand.
| |
Prepare |
Prepare content for rendering.
| |
Render | ||
Render(StiContainer) |
Renders a component in the specified container with events generation.
| |
Render(StiComponent, StiContainer) |
Renders a component in the specified container with events generation.
The rendered component will return in 'renderedComponent' argument.
| |
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.
| |
Reset |
Reset selection of component.
| |
RestoreState |
Restores the earlier saved object state.
| |
SaveState |
Saves the current state of an object.
| |
SaveToJsonObject | ||
Select |
Select component.
| |
SetDirectDisplayRectangle | ||
SetPaintRectangle |
Internal use only.
| |
SetReportVariables | ||
ToString |
Returns an Name of the component and/or the Alias of the component.
(Overrides ObjectToString.) | |
ToString(Boolean) | ||
UnPrepare |
Clear component afrer render.
|
Name | Description | |
---|---|---|
AfterPrint |
Occurs after the component printing.
| |
BeforePrint |
Occurs before printing of the component.
| |
Click |
Occurs when user clicks on the component in the window of viewer.
| |
DoubleClick |
Occurs when user double clicks on the component in the window of viewer.
| |
GetBookmark |
Occurs when getting of the Bookmark for the component.
| |
GetDrillDownReport |
Occurs when it is required to get a report for the Drill-Down operation.
| |
GetHyperlink |
Occurs when getting Hyperlink for the component.
| |
GetTag |
Occurs when getting a Tag for a component.
| |
GetToolTip |
Occurs when getting the ToolTip for the component.
| |
MouseEnter |
Occurs when user enters the mouse into the area of the component in the window of viewer.
| |
MouseLeave |
Occurs when user leaves the mouse out of the area of the component in the window of viewer.
| |
Painted |
Occurs after the component was painted.
| |
Painting |
Occurs before the component painting.
|