| Package | stimulsoft.report.components.simpleComponents |
| Class | public class StiShape |
| Inheritance | StiShape  StiComponent StiBase StiService StiObject Object |
| Implements | IStiBrush, IStiBorderColor, IStiExportImageExtended, IStiShape |
| Property | Defined By | ||
|---|---|---|---|
 | afterPrintEvent : StiAfterPrintEvent Occurs after the component printing. | StiComponent | |
| alias : String Gets or sets a text that will be shown instead of a component name. | StiComponent | |
| allowDelete : Boolean [read-only] Gets a value which indicates whether deleting of the components is allowed. | StiComponent | |
| beforePrintEvent : StiBeforePrintEvent Occurs before printing of the component. | StiComponent | |
| bookmark : StiBookmarkExpression Gets or sets the expression to fill a component bookmark. | StiComponent | |
| bookmarkValue : String Gets or sets the component bookmark. | StiComponent | |
| borderColor : StiColor Gets or sets border color. | StiShape | ||
| bottom : Number [read-only] Gets bottom position of a component. | StiComponent | |
| brush : StiBrush Gets or sets a brush to fill a component. | StiShape | ||
| canGrow : Boolean [override] | StiShape | ||
| canShrink : Boolean [override] | StiShape | ||
| clickEvent : StiClickEvent Occurs when user clicks on the component in the window of viewer. | StiComponent | |
| clientRectangle : StiRectangle Gets or sets the client area of a component. | StiComponent | |
| componentPlacement : String | StiComponent | |
| componentStyle : String Gets or sets a style of a component. | StiComponent | |
| componentType : int [read-only] Gets the type of processing when printing. | StiComponent | |
| conditions : StiConditionsCollection Gets or sets the collection of conditions. | StiComponent | |
| currentBookmark : StiBookmark Gets or sets current bookmark for this component. | StiComponent | |
| defaultClientRectangle : StiRectangle [override] [read-only] Gets or sets the default client area of a component. | StiShape | ||
| delimiterComponent : Boolean Gets or sets a value indicates that this component is used as the delimiter. | StiComponent | |
| displayRectangle : StiRectangle
Gets or sets a rectangle of the component which it fills. | StiComponent | |
| dockable : Boolean Gets or sets a value which indicates whether the component will be docked or not. | StiComponent | |
| dockStyle : int Gets or sets a type of the component docking. | StiComponent | |
| doubleClickEvent : StiDoubleClickEvent Occurs when user double clicks on the component in the window of viewer. | StiComponent | |
| drillDownParameters : StiDictionaryCollection | StiComponent | |
| enabled : Boolean Gets or sets a value which indicates will this component be available or not. | StiComponent | |
| forceRedrawAll : Boolean [read-only]
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. | StiComponent | |
| getBookmarkEvent : StiGetBookmarkEvent Occurs when getting a Bookmark for the component. | StiComponent | |
| getDrillDownReportEvent : StiGetDrillDownReportEvent Occurs when it is required to get a report for the Drill-Down operation. | StiComponent | |
| getHyperlinkEvent : StiGetHyperlinkEvent Occurs when getting a Hyperlink for the component. | StiComponent | |
| getTagEvent : StiGetTagEvent Occurs when getting a Tag for the component. | StiComponent | |
| getToolTipEvent : StiGetToolTipEvent Occurs when getting a ToolTip for the component. | StiComponent | |
| growToHeight : Boolean Gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container. | StiComponent | |
| guid : String | StiComponent | |
| height : Number Gets or sets height of a component. | StiComponent | |
| highlightState : int Gets or sets a state of highlight. | StiComponent | |
| hyperlink : StiHyperlinkExpression Gets or sets an expression to fill a component hyperlink. | StiComponent | |
| hyperlinkValue : String Gets or sets hyperlink of a component. | StiComponent | |
| ignoreNamingRule : Boolean Internal use only. | StiComponent | |
| inherited : Boolean | StiComponent | |
| interaction : StiInteraction Gets interaction options of this component. | StiComponent | |
| isAllowUseInTableMode : Boolean [read-only] Возможно ли добавиль компонент в групповое выделение | StiComponent | |
| isAutomaticDock : Boolean [read-only] Gets a value which indicates that this is an automatic docking. | StiComponent | |
| isCross : Boolean [read-only] | StiComponent | |
| isDesigning : Boolean [read-only] Gets a value which indicates that the report in which a component is placed is being designed. | StiComponent | |
| isEnabled : Boolean [read-only] | StiComponent | |
| isExporting : Boolean [read-only] Gets or sets value, which indicates that the report is exporting. | StiComponent | |
| isPrinting : Boolean [read-only] Gets a value which indicates that the component has already been printed. | StiComponent | |
| isRendered : Boolean Gets or sets a value which indicates whether a component is rendered or not. | StiComponent | |
| isSelected : Boolean Gets or sets value indicates is the component selected or not. | StiComponent | |
| isThumbnails : Boolean [read-only] | StiComponent | |
| left : Number Gets or sets left position of a component. | StiComponent | |
| linked : Boolean Gets or sets a value which indicates whether the object snap to the container is turned on. | StiComponent | |
| localizedCategory : String [read-only] Gets a localized name of the component category. | StiBase | |
| localizedName : String [override] [read-only] Gets a localized component name. | StiShape | ||
| locked : Boolean Gets or sets a value which indicates that moving is locked. | StiComponent | |
| maxSize : StiSize Gets or sets maximal size. | StiComponent | |
| minSize : StiSize Gets or sets minimal size. | StiComponent | |
| mouseEnterEvent : StiMouseEnterEvent Occurs when user enters the mouse into the area of the component in the window of viewer. | StiComponent | |
| mouseLeaveEvent : StiMouseLeaveEvent Occurs when user leaves the mouse into the area of the component in the window of viewer. | StiComponent | |
| name : String [override] Gets or sets a name of a component. | StiComponent | |
| page : StiPage Gets or sets the page on which an object is located. | StiComponent | |
| parent : StiContainer Gets or sets the container in which an object is located. | StiComponent | |
| parentBookmark : StiBookmark Gets or sets parent bookmark for this component. | StiComponent | |
| printable : Boolean Gets or sets a value which indicates whether a component is printable or not. | StiComponent | |
| printOn : int Gets or sets a value which indicates on what pages component will be printed. | StiComponent | |
| priority : int [read-only] Gets a component priority. | StiComponent | |
| properties : StiRepositoryItems | StiService | |
| ref : int | StiBase | |
| renderedCount : int Gets or sets a value which indicates how many times a component is rendered. | StiComponent | |
| report : StiReport Gets or sets the report in which the component is located. | StiComponent | |
| restrictions : int Gets or sets value which indicates the restrictions of a component. | StiComponent | |
| right : Number [read-only] Gets right position of a component. | StiComponent | |
| selectionTick : int | StiComponent | |
| selectRectangle : StiRectangle Gets or sets a rectangle of a component selection. | StiComponent | |
| serviceCategory : String [read-only] Gets a service category. | StiService | |
| serviceInfo : String [read-only] Gets a service description. | StiService | |
| serviceName : String [override] [read-only] Gets a service name. | StiBase | |
| serviceType : Class [read-only] Gets a service type. | StiService | |
| shapeType : StiShapeTypeService Gets or sets type of the shape. | StiShape | ||
| shift : Boolean Gets or sets a value which indicates that this component can be shifted. | StiComponent | |
| shiftMode : int Gets or sets a value which indicates the shift mode of a component. | StiComponent | |
| showQuickButtons : Boolean Gets or sets a value which indicates whether it is necessary to show quick buttons. | StiComponent | |
| size : Number Gets or sets size of the border. | StiShape | ||
| states : StiStatesManager [read-only] Gets the component states manager. | StiComponent | |
| style : int Gets or sets a pen style. | StiShape | ||
| tag : StiTagExpression Gets or sets the expression to fill a component tag. | StiComponent | |
| tagValue : String Gets or sets tag of a component. | StiComponent | |
| toolTip : StiToolTipExpression Gets or sets the expression to fill a component tooltip. | StiComponent | |
| toolTipValue : String Gets or sets a component tips. | StiComponent | |
| top : Number Gets or sets top position of a component. | StiComponent | |
| useParentStyles : Boolean Gets or sets a value which indicates that this component must use styles from parent component. | StiComponent | |
| width : Number Gets or sets width of a component. | StiComponent | |
| Method | Defined By | ||
|---|---|---|---|
StiShape(rect:StiRectangle = null) | StiShape | ||
| applyConditions(sender:Object, conditions:StiArrayList):void | StiComponent | |
| canContainIn(component:StiComponent):Boolean Specifies that this component may be located in the specified component. | StiComponent | |
| checkForParentComponent(comp:StiComponent):Boolean | StiComponent | |
| clearAllStates():void Clear all earlier saved object states. | StiComponent | |
clone(... args):Object [override] | StiShape | ||
| componentToPage(value:Number):Number
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
|
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
|
Converts a rectangle from the parent-container coordinates into coordinates of a page. | StiComponent | |
| StiComponent | ||
| doBookmark():void Invokes the GetBookmark event. | StiComponent | |
| dockToContainer():void Docks the component and all of its subordinate components. | StiComponent | |
| StiComponent | ||
| doGetBookmark():void Raises the GetBookmark event. | StiComponent | |
| [static] | StiComponent | |
equals(object:Object):Boolean [override] | StiShape | ||
| Initializes a new instance of the SizeD class from the specified dimensions. | StiComponent | |
| Returns the DataBand in which the component is located. | StiComponent | |
| Returns a rectangle of the component showing. | StiComponent | |
| Retuns an empty rectangle to which docking is possible. | StiComponent | |
| Returns the GroupHeaderBand in which the component is located. | StiComponent | |
getImage(refZoom:StiRefZoom, format:int = 0):BitmapData | StiShape | ||
| getPaintRectangle(convertToHInches:Boolean = true, convertZoom:Boolean = true, docking:Boolean = true):StiRectangle Makes all necessary coversions for showing an object and returns its coordinates. | StiComponent | |
| getQuickInfo():String | StiComponent | |
| getReport():Object | StiComponent | |
| getShortTypeName():String Get a short object type name (without library path). | StiObject | |
| getType():Class | StiObject | |
| getTypeName():String | StiObject | |
| StiComponent | ||
| invert():void Invert selection of component. | StiComponent | |
| invokeAfterPrint(sender:Object):void Raises the AfterPrint event. | StiComponent | |
| invokeBeforePrint(sender:Object):void Raises the BeforePrint event. | StiComponent | |
| invokeEvents():void | StiComponent | |
isExportAsImage(format:int):Boolean [override] | StiShape | ||
| isParentSelect(component:StiComponent):Boolean [static] Retuns true if one of the parent component is selected. | StiComponent | |
| isSimple(object:*):Boolean [static] | StiObject | |
memberwiseClone():Object [override] | StiShape | ||
| newGuid():void | StiComponent | |
| packService():void [override] Packs a service. | StiComponent | |
|
Converts a rectangle from coordinates of a page into the parent-container coordinates. | StiComponent | |
|
Converts a rectangle from coordinates of a page into the parent-container coordinates. | StiComponent | |
| paint(args:StiPaintArgs):void | StiComponent | |
| paintSelection(args:StiPaintArgs):void | StiComponent | |
| prepare():void Подготавливает компонент для рендеринга. | StiComponent | |
| processRemoveComponent():void | StiComponent | |
| StiComponent | ||
| reset():void Reset selection of component. | StiComponent | |
| restoreState(stateName:String):void Restores the earlier saved object state. | StiComponent | |
| saveState(stateName:String):void Saves the current state of an object. | StiComponent | |
| select():void Select component. | StiComponent | |
| setPaintRectangle(rect:StiRectangle):void Internal use only. | StiComponent | |
| setReportVariables():void | StiComponent | |
| toString():String
Returns an Alias of the report or the Name of the report. | StiComponent | |
| unPrepare():void Очищает компонент после рендеринга. | StiComponent | |
| borderColor | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesborderColor:StiColorGets or sets border color.
public function get borderColor():StiColor public function set borderColor(value:StiColor):void| brush | property |
brush:StiBrushGets or sets a brush to fill a component.
public function get brush():StiBrush public function set brush(value:StiBrush):void| canGrow | property |
canGrow:Boolean[override] public function get canGrow():Boolean public function set canGrow(value:Boolean):void| canShrink | property |
canShrink:Boolean[override] public function get canShrink():Boolean public function set canShrink(value:Boolean):void| defaultClientRectangle | property |
defaultClientRectangle:StiRectangle [read-only] [override] Gets or sets the default client area of a component.
public function get defaultClientRectangle():StiRectangle| localizedName | property |
localizedName:String [read-only] [override] Gets a localized component name.
public function get localizedName():String| shapeType | property |
shapeType:StiShapeTypeServiceGets or sets type of the shape.
public function get shapeType():StiShapeTypeService public function set shapeType(value:StiShapeTypeService):void| size | property |
size:NumberGets or sets size of the border.
public function get size():Number public function set size(value:Number):void| style | property |
style:intGets or sets a pen style.
public function get style():int public function set style(value:int):void| StiShape | () | Constructor |
| clone | () | method |
override public function clone(... args):ObjectParameters
... args |
Object |
| equals | () | method |
override public function equals(object:Object):BooleanParameters
object:Object |
Boolean |
| getImage | () | method |
public function getImage(refZoom:StiRefZoom, format:int = 0):BitmapDataParameters
refZoom:StiRefZoom | |
format:int (default = 0) |
BitmapData |
| isExportAsImage | () | method |
override public function isExportAsImage(format:int):BooleanParameters
format:int |
Boolean |
| memberwiseClone | () | method |
override public function memberwiseClone():ObjectReturnsObject |