stimulsoft.report.components.simpleComponents.StiImage

Public Properties

	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
		aspectRatio : Boolean Gets or sets value, indicates that the image will save its aspect ratio.	StiView
		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
		border : StiBorder Gets or sets border of the component.	StiView
		bottom : Number [read-only] Gets bottom position of a component.	StiComponent
		brush : StiBrush Gets or sets a brush to fill a component.	StiView
		canBreak : Boolean Gets or sets value which indicates whether the component can or cannot break its contents on several pages.	StiImage
		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
		dataColumn : String Gets or sets a name of the column that contains the image.	StiImage
		defaultClientRectangle : StiRectangle [override] [read-only] Gets or sets the default client area of a component.	StiImage
		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
		file : String Gets or sets the path to the file that contains the image.	StiImage
		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
		getImageDataEvent : StiGetImageDataEvent Occurs when getting image for the component.	StiImage
		getImageURLEvent : StiGetImageURLEvent Occurs when getting image url for the component.	StiImage
		getTagEvent : StiGetTagEvent Occurs when getting a Tag for the component.	StiComponent
		getToolTipEvent : StiGetToolTipEvent Occurs when getting a ToolTip for the component.	StiComponent
		globalizedName : String Gets or sets special identificator which will be used for report globalization.	StiImage
		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
		horAlignment : int Gets or sets the horizontal alignment of an object.	StiView
		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
		image : String Gets or sets the image.	StiImage
		imageBitmap : BitmapData Копия картинки, сохранённая при загрузке документа либо после рендеринга	StiView
		imageData : StiImageDataExpression Gets or sets the expression to fill a component image property.	StiImage
		imageRotation : int Gets or sets value which indicates how to rotate an image before output.	StiImage
		imageToDraw : String Gets or sets the image that appeared as a result of the component rendering.	StiView
		imageURL : StiImageURLExpression Gets or sets the expression to fill a component image URL.	StiImage
		imageURLValue : String Gets or sets image URL.	StiImage
		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
		isCachedImage : Boolean	StiView
		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.	StiImage
		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
		multipleFactor : Number Gets or sets value to multiply by it an image size.	StiView
		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
		processingDuplicates : int Gets or sets value which indicates how report engine processes duplicated images.	StiImage
		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
		smoothing : Boolean Gets or sets smoothing mode for drawing image.	StiView
		states : StiStatesManager [read-only] Gets the component states manager.	StiComponent
		stretch : Boolean Gets or sets value, indicates that this component will stretch the image till the image will get size equal in its size on the page.	StiView
		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
		vertAlignment : int Gets or sets the vertical alignment of an object.	StiView
		width : Number Gets or sets width of a component.	StiComponent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		StiImage(rect:StiRectangle = null)	StiImage
		applyConditions(sender:Object, conditions:StiArrayList):void	StiComponent
		breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean Divides content of components in two parts.	StiImage
		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]	StiView
		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]	StiImage
		getActualSize():StiSize [override]	StiView
		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
		getImage(refZoom:StiRefZoom, format:int = 0):BitmapData	StiView
		getImageFromSource():String [override] Returns the image being get as a result of rendering.	StiImage
		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 [override]	StiImage
		isExportAsImage(format:int):Boolean [override]	StiView
		isParentSelect(component:StiComponent):Boolean [static] Retuns true if one of the parent component is selected.	StiComponent
		isSimple(object:*):Boolean [static]	StiObject
		memberwiseClone():Object [override]	StiImage
		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
		rotateImage(image:BitmapData):BitmapData	StiImage
		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
		getImageFromDataColumn():String Returns the image from specified data column.	StiImage
		getImageFromUrl():String Returns the image from specified url.	StiImage
		setDirectDisplayRectangle(rect:StiRectangle):void	StiComponent

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

Property Detail

canBreak

property

canBreak:Boolean

Gets or sets value which indicates whether the component can or cannot break its contents on several pages.

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

dataColumn

property

dataColumn:String

Gets or sets a name of the column that contains the image.

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

defaultClientRectangle

property

defaultClientRectangle:StiRectangle [read-only] [override]

Gets or sets the default client area of a component.

Implementation
public function get defaultClientRectangle():StiRectangle

file

property

file:String

Gets or sets the path to the file that contains the image.

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

getImageDataEvent

property

getImageDataEvent:StiGetImageDataEvent

Occurs when getting image for the component.

Implementation
public function get getImageDataEvent():StiGetImageDataEvent
public function set getImageDataEvent(value:StiGetImageDataEvent):void

getImageURLEvent

property

getImageURLEvent:StiGetImageURLEvent

Occurs when getting image url for the component.

Implementation
public function get getImageURLEvent():StiGetImageURLEvent
public function set getImageURLEvent(value:StiGetImageURLEvent):void

globalizedName

property

globalizedName:String

Gets or sets special identificator which will be used for report globalization.

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

image

property

image:String

Gets or sets the image.

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

imageData

property

imageData:StiImageDataExpression

Gets or sets the expression to fill a component image property.

Implementation
public function get imageData():StiImageDataExpression
public function set imageData(value:StiImageDataExpression):void

imageRotation

property

imageRotation:int

Gets or sets value which indicates how to rotate an image before output.

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

imageURL

property

imageURL:StiImageURLExpression

Gets or sets the expression to fill a component image URL.

Implementation
public function get imageURL():StiImageURLExpression
public function set imageURL(value:StiImageURLExpression):void

imageURLValue

property

imageURLValue:String

Gets or sets image URL.

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

localizedName

property

localizedName:String [read-only] [override]

Gets a localized component name.

Implementation
public function get localizedName():String

processingDuplicates

property

processingDuplicates:int

Gets or sets value which indicates how report engine processes duplicated images.

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

Constructor Detail

StiImage

()

Constructor

public function StiImage(rect:StiRectangle = null)

Parameters

rect:StiRectangle (default = null)

Method Detail

breakk

()

method

public function breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean

Divides content of components in two parts. Returns result of dividing. If true, then component is successful divided.

Parameters

	`dividedComponent:StiComponent`

	`devideFactor:Number`

Returns

Boolean

equals

()

method

override public function equals(object:Object):Boolean

Parameters

object:Object

Returns

Boolean

getImageFromDataColumn

()

method

protected function getImageFromDataColumn():String

Returns the image from specified data column.

Returns

String

getImageFromSource

()

method

override public function getImageFromSource():String

Returns the image being get as a result of rendering.

Returns

String

getImageFromUrl

()

method

protected function getImageFromUrl():String

Returns the image from specified url.

Returns

String

invokeEvents

()

method

override public function invokeEvents():void

memberwiseClone

()

method

override public function memberwiseClone():Object

Returns

Object

rotateImage

()

method

public function rotateImage(image:BitmapData):BitmapData

Parameters

image:BitmapData

Returns

BitmapData

Constant Detail

PropertyCanBreak

Constant

protected static const PropertyCanBreak:Object

PropertyProcessingDuplicates

Constant

protected static const PropertyProcessingDuplicates:Object

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

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

Package	stimulsoft.report.components.simpleComponents
Class	public class StiImage
Inheritance	StiImage StiView StiComponent StiBase StiService StiObject Object
Implements	IStiBreakable, IStiGlobalizedName, IStiImage
Subclasses	StiTableCellImage