stimulsoft.report.components.StiComponent

	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
		bottom : Number [read-only] Gets bottom position of a component.	StiComponent
		canGrow : Boolean Gets or sets a value which indicates that this object can grow.	StiComponent
		canShrink : Boolean Gets or sets value which indicates that this object can shrink.	StiComponent
		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 [read-only] Gets the default client area of a component.	StiComponent
		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 [read-only] Gets a localized component name.	StiBase
		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
		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
		states : StiStatesManager [read-only] Gets the component states manager.	StiComponent
		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
		StiComponent(rect:StiRectangle = null)	StiComponent
		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]	StiComponent
		componentToPage(value:Number):Number Converts a rectangle from the parent-container coordinates into coordinates of a page.	StiComponent
		componentToPageP(point:StiPoint):StiPoint Converts a rectangle from the parent-container coordinates into coordinates of a page.	StiComponent
		componentToPageR(rect:StiRectangle):StiRectangle Converts a rectangle from the parent-container coordinates into coordinates of a page.	StiComponent
		convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void	StiComponent
		doBookmark():void Invokes the GetBookmark event.	StiComponent
		dockToContainer():void Docks the component and all of its subordinate components.	StiComponent
		dockToContainerRectangle(rect:StiRectangle):StiRectangle	StiComponent
		doGetBookmark():void Raises the GetBookmark event.	StiComponent
		doOffsetRect(component:StiComponent, rect:StiRectangle, offsetRect:StiRectangle):StiRectangle [static]	StiComponent
		equals(object:Object):Boolean [override]	StiComponent
		getActualSize():StiSize Initializes a new instance of the SizeD class from the specified dimensions.	StiComponent
		getDataBand():StiDataBand Returns the DataBand in which the component is located.	StiComponent
		getDisplayRectangle():StiRectangle Returns a rectangle of the component showing.	StiComponent
		getDockRegion(parent:StiComponent, useColumns:Boolean = true):StiRectangle Retuns an empty rectangle to which docking is possible.	StiComponent
		getGroupHeaderBand():StiGroupHeaderBand Returns the GroupHeaderBand in which the component is located.	StiComponent
		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
		internalRender():StiComponent	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	StiComponent
		isParentSelect(component:StiComponent):Boolean [static] Retuns true if one of the parent component is selected.	StiComponent
		isSimple(object:*):Boolean [static]	StiObject
		memberwiseClone():Object [override]	StiComponent
		newGuid():void	StiComponent
		packService():void [override] Packs a service.	StiComponent
		pageToComponentP(point:StiPoint):StiPoint Converts a rectangle from coordinates of a page into the parent-container coordinates.	StiComponent
		pageToComponentR(rect:StiRectangle):StiRectangle 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
		render():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

	Method	Defined By
		allowPrintOn():Boolean	StiComponent
		setDirectDisplayRectangle(rect:StiRectangle):void	StiComponent

	Constant	Defined By
		PropertyComponentStyle : Object [static]	StiComponent
		PropertyDelimiterComponent : Object [static]	StiComponent
		PropertyDockable : Object [static]	StiComponent
		PropertyInherited : Object [static]	StiComponent
		PropertyLinked : Object [static]	StiComponent
		PropertyLocked : Object [static]	StiComponent
		PropertyRenderedCount : Object [static]	StiComponent
		PropertyRestrictions : Object [static]	StiComponent
		PropertySelectionTick : Object [static]	StiComponent
		PropertyShowQuickButtons : Object [static]	StiComponent
		PropertyUseParentStyles : Object [static]	StiComponent

Property Detail

afterPrintEvent

property

afterPrintEvent:StiAfterPrintEvent

Occurs after the component printing.

Implementation
public function get afterPrintEvent():StiAfterPrintEvent
public function set afterPrintEvent(value:StiAfterPrintEvent):void

alias

property

alias:String

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.

Implementation
public function get alias():String
public function set alias(value:String):void

allowDelete

property

allowDelete:Boolean [read-only]

Gets a value which indicates whether deleting of the components is allowed.

Implementation
public function get allowDelete():Boolean

beforePrintEvent

property

beforePrintEvent:StiBeforePrintEvent

Occurs before printing of the component.

Implementation
public function get beforePrintEvent():StiBeforePrintEvent
public function set beforePrintEvent(value:StiBeforePrintEvent):void

bookmark

property

bookmark:StiBookmarkExpression

Gets or sets the expression to fill a component bookmark.

Implementation
public function get bookmark():StiBookmarkExpression
public function set bookmark(value:StiBookmarkExpression):void

bookmarkValue

property

bookmarkValue:String

Gets or sets the component bookmark.

Implementation
public function get bookmarkValue():String
public function set bookmarkValue(value:String):void

bottom

property

bottom:Number [read-only]

Gets bottom position of a component.

Implementation
public function get bottom():Number

canGrow

property

canGrow:Boolean

Gets or sets a value which indicates that this object can grow.

Implementation
public function get canGrow():Boolean
public function set canGrow(value:Boolean):void

canShrink

property

canShrink:Boolean

Gets or sets value which indicates that this object can shrink.

Implementation
public function get canShrink():Boolean
public function set canShrink(value:Boolean):void

clickEvent

property

clickEvent:StiClickEvent

Occurs when user clicks on the component in the window of viewer.

Implementation
public function get clickEvent():StiClickEvent
public function set clickEvent(value:StiClickEvent):void

clientRectangle

property

clientRectangle:StiRectangle

Gets or sets the client area of a component.

Implementation
public function get clientRectangle():StiRectangle
public function set clientRectangle(value:StiRectangle):void

componentPlacement

property

componentPlacement:String

Implementation
public function get componentPlacement():String
public function set componentPlacement(value:String):void

componentStyle

property

componentStyle:String

Gets or sets a style of a component.

Implementation
public function get componentStyle():String
public function set componentStyle(value:String):void

componentType

property

componentType:int [read-only]

Gets the type of processing when printing.

Implementation
public function get componentType():int

conditions

property

conditions:StiConditionsCollection

Gets or sets the collection of conditions.

Implementation
public function get conditions():StiConditionsCollection
public function set conditions(value:StiConditionsCollection):void

currentBookmark

property

currentBookmark:StiBookmark

Gets or sets current bookmark for this component.

Implementation
public function get currentBookmark():StiBookmark
public function set currentBookmark(value:StiBookmark):void

defaultClientRectangle

property

defaultClientRectangle:StiRectangle [read-only]

Gets the default client area of a component.

Implementation
public function get defaultClientRectangle():StiRectangle

delimiterComponent

property

delimiterComponent:Boolean

Gets or sets a value indicates that this component is used as the delimiter.

Implementation
public function get delimiterComponent():Boolean
public function set delimiterComponent(value:Boolean):void

displayRectangle

property

displayRectangle:StiRectangle

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).

Implementation
public function get displayRectangle():StiRectangle
public function set displayRectangle(value:StiRectangle):void

dockable

property

dockable:Boolean

Gets or sets a value which indicates whether the component will be docked or not.

Implementation
public function get dockable():Boolean
public function set dockable(value:Boolean):void

dockStyle

property

dockStyle:int

Gets or sets a type of the component docking.

Implementation
public function get dockStyle():int
public function set dockStyle(value:int):void

doubleClickEvent

property

doubleClickEvent:StiDoubleClickEvent

Occurs when user double clicks on the component in the window of viewer.

Implementation
public function get doubleClickEvent():StiDoubleClickEvent
public function set doubleClickEvent(value:StiDoubleClickEvent):void

drillDownParameters

property

drillDownParameters:StiDictionaryCollection

Implementation
public function get drillDownParameters():StiDictionaryCollection
public function set drillDownParameters(value:StiDictionaryCollection):void

enabled

property

enabled:Boolean

Gets or sets a value which indicates will this component be available or not.

Implementation
public function get enabled():Boolean
public function set enabled(value:Boolean):void

forceRedrawAll

property

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.

Implementation
public function get forceRedrawAll():Boolean

getBookmarkEvent

property

getBookmarkEvent:StiGetBookmarkEvent

Occurs when getting a Bookmark for the component.

Implementation
public function get getBookmarkEvent():StiGetBookmarkEvent
public function set getBookmarkEvent(value:StiGetBookmarkEvent):void

getDrillDownReportEvent

property

getDrillDownReportEvent:StiGetDrillDownReportEvent

Occurs when it is required to get a report for the Drill-Down operation.

Implementation
public function get getDrillDownReportEvent():StiGetDrillDownReportEvent
public function set getDrillDownReportEvent(value:StiGetDrillDownReportEvent):void

getHyperlinkEvent

property

getHyperlinkEvent:StiGetHyperlinkEvent

Occurs when getting a Hyperlink for the component.

Implementation
public function get getHyperlinkEvent():StiGetHyperlinkEvent
public function set getHyperlinkEvent(value:StiGetHyperlinkEvent):void

getTagEvent

property

getTagEvent:StiGetTagEvent

Occurs when getting a Tag for the component.

Implementation
public function get getTagEvent():StiGetTagEvent
public function set getTagEvent(value:StiGetTagEvent):void

getToolTipEvent

property

getToolTipEvent:StiGetToolTipEvent

Occurs when getting a ToolTip for the component.

Implementation
public function get getToolTipEvent():StiGetToolTipEvent
public function set getToolTipEvent(value:StiGetToolTipEvent):void

growToHeight

property

growToHeight:Boolean

Gets or sets a value which indicates that the height of this component increases/decreases to the bottom of a container.

Implementation
public function get growToHeight():Boolean
public function set growToHeight(value:Boolean):void

guid

property

guid:String

Implementation
public function get guid():String
public function set guid(value:String):void

height

property

height:Number

Gets or sets height of a component.

Implementation
public function get height():Number
public function set height(value:Number):void

highlightState

property

highlightState:int

Gets or sets a state of highlight.

Implementation
public function get highlightState():int
public function set highlightState(value:int):void

hyperlink

property

hyperlink:StiHyperlinkExpression

Gets or sets an expression to fill a component hyperlink.

Implementation
public function get hyperlink():StiHyperlinkExpression
public function set hyperlink(value:StiHyperlinkExpression):void

hyperlinkValue

property

hyperlinkValue:String

Gets or sets hyperlink of a component.

Implementation
public function get hyperlinkValue():String
public function set hyperlinkValue(value:String):void

ignoreNamingRule

property

ignoreNamingRule:Boolean

Internal use only.

Implementation
public function get ignoreNamingRule():Boolean
public function set ignoreNamingRule(value:Boolean):void

inherited

property

inherited:Boolean

Implementation
public function get inherited():Boolean
public function set inherited(value:Boolean):void

interaction

property

interaction:StiInteraction

Gets interaction options of this component.

Implementation
public function get interaction():StiInteraction
public function set interaction(value:StiInteraction):void

isAllowUseInTableMode

property

isAllowUseInTableMode:Boolean [read-only]

Возможно ли добавиль компонент в групповое выделение

Implementation
public function get isAllowUseInTableMode():Boolean

isAutomaticDock

property

isAutomaticDock:Boolean [read-only]

Gets a value which indicates that this is an automatic docking.

Implementation
public function get isAutomaticDock():Boolean

isCross

property

isCross:Boolean [read-only]

Implementation
public function get isCross():Boolean

isDesigning

property

isDesigning:Boolean [read-only]

Gets a value which indicates that the report in which a component is placed is being designed.

Implementation
public function get isDesigning():Boolean

isEnabled

property

isEnabled:Boolean [read-only]

Implementation
public function get isEnabled():Boolean

isExporting

property

isExporting:Boolean [read-only]

Gets or sets value, which indicates that the report is exporting.

Implementation
public function get isExporting():Boolean

isPrinting

property

isPrinting:Boolean [read-only]

Gets a value which indicates that the component has already been printed.

Implementation
public function get isPrinting():Boolean

isRendered

property

isRendered:Boolean

Gets or sets a value which indicates whether a component is rendered or not.

Implementation
public function get isRendered():Boolean
public function set isRendered(value:Boolean):void

isSelected

property

isSelected:Boolean

Gets or sets value indicates is the component selected or not.

Implementation
public function get isSelected():Boolean
public function set isSelected(value:Boolean):void

isThumbnails

property

isThumbnails:Boolean [read-only]

Implementation
public function get isThumbnails():Boolean

left

property

left:Number

Gets or sets left position of a component.

Implementation
public function get left():Number
public function set left(value:Number):void

linked

property

linked:Boolean

Gets or sets a value which indicates whether the object snap to the container is turned on.

Implementation
public function get linked():Boolean
public function set linked(value:Boolean):void

locked

property

locked:Boolean

Gets or sets a value which indicates that moving is locked.

Implementation
public function get locked():Boolean
public function set locked(value:Boolean):void

maxSize

property

maxSize:StiSize

Gets or sets maximal size.

Implementation
public function get maxSize():StiSize
public function set maxSize(value:StiSize):void

minSize

property

minSize:StiSize

Gets or sets minimal size.

Implementation
public function get minSize():StiSize
public function set minSize(value:StiSize):void

mouseEnterEvent

property

mouseEnterEvent:StiMouseEnterEvent

Occurs when user enters the mouse into the area of the component in the window of viewer.

Implementation
public function get mouseEnterEvent():StiMouseEnterEvent
public function set mouseEnterEvent(value:StiMouseEnterEvent):void

mouseLeaveEvent

property

mouseLeaveEvent:StiMouseLeaveEvent

Occurs when user leaves the mouse into the area of the component in the window of viewer.

Implementation
public function get mouseLeaveEvent():StiMouseLeaveEvent
public function set mouseLeaveEvent(value:StiMouseLeaveEvent):void

name

property

name:String[override]

Gets or sets a name of a component.

Implementation
public function get name():String
public function set name(value:String):void

page

property

page:StiPage

Gets or sets the page on which an object is located.

Implementation
public function get page():StiPage
public function set page(value:StiPage):void

parent

property

parent:StiContainer

Gets or sets the container in which an object is located.

Implementation
public function get parent():StiContainer
public function set parent(value:StiContainer):void

parentBookmark

property

parentBookmark:StiBookmark

Gets or sets parent bookmark for this component.

Implementation
public function get parentBookmark():StiBookmark
public function set parentBookmark(value:StiBookmark):void

printable

property

printable:Boolean

Gets or sets a value which indicates whether a component is printable or not.

Implementation
public function get printable():Boolean
public function set printable(value:Boolean):void

printOn

property

printOn:int

Gets or sets a value which indicates on what pages component will be printed.

Implementation
public function get printOn():int
public function set printOn(value:int):void

priority

property

priority:int [read-only]

Gets a component priority.

Implementation
public function get priority():int

renderedCount

property

renderedCount:int

Gets or sets a value which indicates how many times a component is rendered.

Implementation
public function get renderedCount():int
public function set renderedCount(value:int):void

report

property

report:StiReport

Gets or sets the report in which the component is located.

Implementation
public function get report():StiReport
public function set report(value:StiReport):void

restrictions

property

restrictions:int

Gets or sets value which indicates the restrictions of a component.

Implementation
public function get restrictions():int
public function set restrictions(value:int):void

right

property

right:Number [read-only]

Gets right position of a component.

Implementation
public function get right():Number

selectionTick

property

selectionTick:int

Implementation
public function get selectionTick():int
public function set selectionTick(value:int):void

selectRectangle

property

selectRectangle:StiRectangle

Gets or sets a rectangle of a component selection.

Implementation
public function get selectRectangle():StiRectangle
public function set selectRectangle(value:StiRectangle):void

shift

property

shift:Boolean

Gets or sets a value which indicates that this component can be shifted.

Implementation
public function get shift():Boolean
public function set shift(value:Boolean):void

shiftMode

property

shiftMode:int

Gets or sets a value which indicates the shift mode of a component.

Implementation
public function get shiftMode():int
public function set shiftMode(value:int):void

showQuickButtons

property

showQuickButtons:Boolean

Gets or sets a value which indicates whether it is necessary to show quick buttons.

Implementation
public function get showQuickButtons():Boolean
public function set showQuickButtons(value:Boolean):void

states

property

states:StiStatesManager [read-only]

Gets the component states manager.

Implementation
public function get states():StiStatesManager

tag

property

tag:StiTagExpression

Gets or sets the expression to fill a component tag.

Implementation
public function get tag():StiTagExpression
public function set tag(value:StiTagExpression):void

tagValue

property

tagValue:String

Gets or sets tag of a component.

Implementation
public function get tagValue():String
public function set tagValue(value:String):void

toolTip

property

toolTip:StiToolTipExpression

Gets or sets the expression to fill a component tooltip.

Implementation
public function get toolTip():StiToolTipExpression
public function set toolTip(value:StiToolTipExpression):void

toolTipValue

property

toolTipValue:String

Gets or sets a component tips.

Implementation
public function get toolTipValue():String
public function set toolTipValue(value:String):void

top

property

top:Number

Gets or sets top position of a component.

Implementation
public function get top():Number
public function set top(value:Number):void

useParentStyles

property

useParentStyles:Boolean

Gets or sets a value which indicates that this component must use styles from parent component.

Implementation
public function get useParentStyles():Boolean
public function set useParentStyles(value:Boolean):void

width

property

width:Number

Gets or sets width of a component.

Implementation
public function get width():Number
public function set width(value:Number):void

Constructor Detail

StiComponent

()

Constructor

public function StiComponent(rect:StiRectangle = null)

Parameters

rect:StiRectangle (default = null)

Method Detail

allowPrintOn

()

method

protected function allowPrintOn():Boolean

Returns

Boolean

applyConditions

()

method

public function applyConditions(sender:Object, conditions:StiArrayList):void

Parameters

	`sender:Object`

	`conditions:StiArrayList`

canContainIn

()

method

public function canContainIn(component:StiComponent):Boolean

Specifies that this component may be located in the specified component.

Parameters

component:StiComponent

Returns

Boolean

checkForParentComponent

()

method

public function checkForParentComponent(comp:StiComponent):Boolean

Parameters

comp:StiComponent

Returns

Boolean

clearAllStates

()

method

public function clearAllStates():void

Clear all earlier saved object states.

clone

()

method

override public function clone(... args):Object

Parameters

... args

Returns

Object

componentToPage

()

method

public function componentToPage(value:Number):Number

Converts a rectangle from the parent-container coordinates into coordinates of a page. The method calls the ContainerToPage method of the parent component.

Parameters

value:Number

Returns

Number

componentToPageP

()

method

public function componentToPageP(point:StiPoint):StiPoint

Converts a rectangle from the parent-container coordinates into coordinates of a page. The method calls the ContainerToPage method of the parent component.

Parameters

point:StiPoint

Returns

StiPoint

componentToPageR

()

method

public function componentToPageR(rect:StiRectangle):StiRectangle

Converts a rectangle from the parent-container coordinates into coordinates of a page. The method calls the ContainerToPage method of the parent component.

Parameters

rect:StiRectangle

Returns

StiRectangle

convert

()

method

public function convert(oldUnit:StiUnit, newUnit:StiUnit, convertComponents:Boolean = true):void

Parameters

	`oldUnit:StiUnit`

	`newUnit:StiUnit`

	`convertComponents:Boolean` (default = `true`)

doBookmark

()

method

public function doBookmark():void

Invokes the GetBookmark event.

dockToContainer

()

method

public function dockToContainer():void

Docks the component and all of its subordinate components.

dockToContainerRectangle

()

method

public function dockToContainerRectangle(rect:StiRectangle):StiRectangle

Parameters

rect:StiRectangle

Returns

StiRectangle

doGetBookmark

()

method

public function doGetBookmark():void

Raises the GetBookmark event.

doOffsetRect

()

method

public static function doOffsetRect(component:StiComponent, rect:StiRectangle, offsetRect:StiRectangle):StiRectangle

Parameters

	`component:StiComponent`

	`rect:StiRectangle`

	`offsetRect:StiRectangle`

Returns

StiRectangle

equals

()

method

override public function equals(object:Object):Boolean

Parameters

object:Object

Returns

Boolean

getActualSize

()

method

public function getActualSize():StiSize

Initializes a new instance of the SizeD class from the specified dimensions.

Returns

StiSize

getDataBand

()

method

public function getDataBand():StiDataBand

Returns the DataBand in which the component is located. Returns null, if nothing is located.

Returns

StiDataBand

getDisplayRectangle

()

method

public function getDisplayRectangle():StiRectangle

Returns a rectangle of the component showing.

Returns

StiRectangle

getDockRegion

()

method

public function getDockRegion(parent:StiComponent, useColumns:Boolean = true):StiRectangle

Retuns an empty rectangle to which docking is possible.

Parameters

	`parent:StiComponent`

	`useColumns:Boolean` (default = `true`)

Returns

StiRectangle

getGroupHeaderBand

()

method

public function getGroupHeaderBand():StiGroupHeaderBand

Returns the GroupHeaderBand in which the component is located. Returns null, if nothing is located.

Returns

StiGroupHeaderBand

getPaintRectangle

()

method

 public function getPaintRectangle(convertToHInches:Boolean = true, convertZoom:Boolean = true, docking:Boolean = true):StiRectangle

Makes all necessary coversions for showing an object and returns its coordinates.

Parameters

	`convertToHInches:Boolean` (default = `true`)

	`convertZoom:Boolean` (default = `true`)

	`docking:Boolean` (default = `true`)

Returns

StiRectangle

getQuickInfo

()

method

public function getQuickInfo():String

Returns

String

getReport

()

method

public function getReport():Object

Returns

Object

internalRender

()

method

public function internalRender():StiComponent

Returns

StiComponent

invert

()

method

public function invert():void

Invert selection of component.

invokeAfterPrint

()

method

public function invokeAfterPrint(sender:Object):void

Raises the AfterPrint event. "sender" > A sender which invokes an event. "e" > A parameter which contains event data.

Parameters

sender:Object

invokeBeforePrint

()

method

public function invokeBeforePrint(sender:Object):void

Raises the BeforePrint event. "sender" > A sender which invokes an event. "e" > A parameter which contains event data.

Parameters

sender:Object

invokeEvents

()

method

public function invokeEvents():void

isExportAsImage

()

method

public function isExportAsImage(format:int):Boolean

Parameters

format:int

Returns

Boolean

isParentSelect

()

method

public static function isParentSelect(component:StiComponent):Boolean

Retuns true if one of the parent component is selected.

Parameters

component:StiComponent

Returns

Boolean

memberwiseClone

()

method

override public function memberwiseClone():Object

Returns

Object

newGuid

()

method

public function newGuid():void

packService

()

method

override public function packService():void

Packs a service.

pageToComponentP

()

method

public function pageToComponentP(point:StiPoint):StiPoint

Converts a rectangle from coordinates of a page into the parent-container coordinates. The method calls the PageToContainer method of the parent component.

Parameters

point:StiPoint

Returns

StiPoint

pageToComponentR

()

method

public function pageToComponentR(rect:StiRectangle):StiRectangle

Converts a rectangle from coordinates of a page into the parent-container coordinates. The method calls the PageToContainer method of the parent component.

Parameters

rect:StiRectangle

Returns

StiRectangle

paint

()

method

public function paint(args:StiPaintArgs):void

Parameters

args:StiPaintArgs

paintSelection

()

method

public function paintSelection(args:StiPaintArgs):void

Parameters

args:StiPaintArgs

prepare

()

method

public function prepare():void

Подготавливает компонент для рендеринга.

processRemoveComponent

()

method

public function processRemoveComponent():void

render

()

method

public function render():StiComponent

Returns

StiComponent

reset

()

method

public function reset():void

Reset selection of component.

restoreState

()

method

public function restoreState(stateName:String):void

Restores the earlier saved object state.

Parameters

stateName:String

saveState

()

method

public function saveState(stateName:String):void

Saves the current state of an object.

Parameters

stateName:String

select

()

method

public function select():void

Select component.

setDirectDisplayRectangle

()

method

protected function setDirectDisplayRectangle(rect:StiRectangle):void

Parameters

rect:StiRectangle

setPaintRectangle

()

method

public function setPaintRectangle(rect:StiRectangle):void

Internal use only.

Parameters

rect:StiRectangle

setReportVariables

()

method

public function setReportVariables():void

toString

()

method

public function toString():String

Returns an Alias of the report or the Name of the report.

Returns

String

unPrepare

()

method

public function unPrepare():void

Очищает компонент после рендеринга.

Constant Detail

PropertyComponentStyle

Constant

protected static const PropertyComponentStyle:Object

PropertyDelimiterComponent

Constant

protected static const PropertyDelimiterComponent:Object

PropertyDockable

Constant

protected static const PropertyDockable:Object

PropertyInherited

Constant

protected static const PropertyInherited:Object

PropertyLinked

Constant

protected static const PropertyLinked:Object

PropertyLocked

Constant

protected static const PropertyLocked:Object

PropertyRenderedCount

Constant

protected static const PropertyRenderedCount:Object

PropertyRestrictions

Constant

protected static const PropertyRestrictions:Object

PropertySelectionTick

Constant

protected static const PropertySelectionTick:Object

PropertyShowQuickButtons

Constant

protected static const PropertyShowQuickButtons:Object

PropertyUseParentStyles

Constant

protected static const PropertyUseParentStyles:Object

Mon Mar 27 2017, 09:08 AM +03:00

Stimulsoft Reports.Flex Class Reference	All Packages \| All Classes \| Index \| Frames No Frames
StiComponent	Properties \| Methods \| Constants

Package	stimulsoft.report.components
Class	public class StiComponent
Inheritance	StiComponent StiBase StiService StiObject Object
Implements	IStiComponentGuid, IStiCanGrow, IStiCanShrink, IStiUnitConvert, IStiShift, IStiGrowToHeight, IStiConditions, IStiPrintOn, IStiInherited, IStiReportProperty, IStiInteraction, IStiSelect, IStiComponent, IStiSerializable
Subclasses	StiBarCode, StiChart, StiCheckBox, StiContainer, StiPrimitive, StiShape, StiSimpleText, StiUndefinedComponent, StiView, StiWinControl, StiZipCode