stimulsoft.report.components.simpleComponents.StiRichText

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
		backColor : StiColor Gets or sets a back color.	StiRichText
		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 frame of the component.	StiRichText
		bottom : Number [read-only] Gets bottom position of a component.	StiComponent
		canBreak : Boolean Gets or sets value which indicates whether the component can or cannot break its contents on several pages.	StiRichText
		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
		componentGuid : String Internal use only.	StiSimpleText
		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 RTF text.	StiRichText
		defaultClientRectangle : StiRectangle [read-only] Gets the default client area of a component.	StiComponent
		defaultColor : StiColor Gets or sets default color.	StiRichText
		defaultFont : StiFont Gets or sets default font.	StiRichText
		delimiterComponent : Boolean Gets or sets a value indicates that this component is used as the delimiter.	StiComponent
		detectUrls : Boolean Gets or sets detection of urls.	StiRichText
		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
		editable : Boolean Gets or sets value indicates that a component can be edited in the window of viewer.	StiSimpleText
		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
		fullConvertExpression : Boolean Gets or sets value which indicates that it is necessary to fully convert the expression to Rtf format.	StiRichText
		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
		getValueEvent : StiGetValueEvent Occurs when the text is being prepared for rendering.	StiSimpleText
		globalizedName : String [override]	StiRichText
		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
		hideZeros : Boolean [override]	StiRichText
		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
		linesOfUnderline : int [override]	StiRichText
		linesOfUnderlining : Boolean Gets or sets value indicates that it is necessary to lines of underlining.	StiSimpleText
		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.	StiRichText
		locked : Boolean Gets or sets a value which indicates that moving is locked.	StiComponent
		margins : StiMargins Gets or sets text margins.	StiRichText
		maxNumberOfLines : int [override]	StiRichText
		maxSize : StiSize Gets or sets maximal size.	StiComponent
		mergeDuplicates : Boolean	StiSimpleText
		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
		onlyText : Boolean Gets or sets value indicates that the text expression contains a text only.	StiSimpleText
		page : StiPage [override]	StiRichText
		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
		processAt : int Gets or sets a value indicates whether to process a text expression of this component at the end of the page rendering or at the end of the report rendering.	StiSimpleText
		processingDuplicates : int [override]	StiRichText
		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
		text : StiExpression [override] Gets or sets text expression.	StiRichText
		textValue : String Gets or sets text value.	StiSimpleText
		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
		_totalValueHelp : String = null	StiSimpleText
		totalValueHelp : String Internal use only.	StiSimpleText
		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
		wordWrap : Boolean Gets or sets word wrap.	StiRichText
		wysiwyg : Boolean Gets or sets value which indicates that it is necessary to use the Wysiwyg mode of the rendering.	StiRichText

	Property	Defined By
		PropertyProcessAt : Object [static]	StiSimpleText

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		StiRichText(rect:StiRectangle = null, text:String)	StiRichText
		applyConditions(sender:Object, conditions:StiArrayList):void	StiComponent
		breakk(dividedComponent:StiComponent, devideFactor:Number):Boolean Divides content of components in two parts.	StiRichText
		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]	StiRichText
		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]	StiRichText
		getActualSize():StiSize Initializes a new instance of the SizeD class from the specified dimensions.	StiComponent
		getAllStrings():Array Returns array of the property names which can be localized.	StiRichText
		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	StiRichText
		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 [override]	StiSimpleText
		getReport():Object	StiComponent
		getShortTypeName():String Get a short object type name (without library path).	StiObject
		getString(propertyName:String):String Gets localized string from specified property name.	StiRichText
		getTextInternal():String Internal use only.	StiSimpleText
		getTextWithoutZero(text:String):String	StiSimpleText
		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
		invokeGetValue(sender:StiComponent, e:StiGetValueEventArgs):void Raises the GetValue event.	StiSimpleText
		invokeTextProcess(sender:StiComponent, e:StiValueEventArgs):void Raises the TextProcess event.	StiSimpleText
		isExportAsImage(format:int):Boolean [override]	StiRichText
		isParentSelect(component:StiComponent):Boolean [static] Retuns true if one of the parent component is selected.	StiComponent
		isSimple(object:*):Boolean [static]	StiObject
		memberwiseClone():Object [override]	StiRichText
		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
		processText(text:String):String	StiSimpleText
		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
		setString(propertyName:String, value:String):void Sets localized string to specified property name.	StiRichText
		setText(getValue:Object, value:String):void Sets the text value in all printed objects.	StiSimpleText
		setTextInternal(value:String):void Internal use only.	StiSimpleText
		toString():String Returns an Alias of the report or the Name of the report.	StiComponent
		unPrepare():void Очищает компонент после рендеринга.	StiComponent
		updateComponentImage():void	StiRichText

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

	Constant	Defined By
		PropertyCanBreak : Object [static]	StiRichText
		PropertyComponentStyle : Object [static]	StiComponent
		PropertyDelimiterComponent : Object [static]	StiComponent
		PropertyDockable : Object [static]	StiComponent
		PropertyGlobalizedName : Object [static]	StiSimpleText
		PropertyInherited : Object [static]	StiComponent
		PropertyLinked : Object [static]	StiComponent
		PropertyLocked : Object [static]	StiComponent
		PropertyMaxNumberOfLines : Object [static]	StiSimpleText
		PropertyOnlyText : Object [static]	StiSimpleText
		PropertyProcessingDuplicates : Object [static]	StiSimpleText
		PropertyRenderedCount : Object [static]	StiComponent
		PropertyRestrictions : Object [static]	StiComponent
		PropertySelectionTick : Object [static]	StiComponent
		PropertyShowQuickButtons : Object [static]	StiComponent
		PropertyUseParentStyles : Object [static]	StiComponent

Property Detail

backColor

property

backColor:StiColor

Gets or sets a back color.

Implementation
public function get backColor():StiColor
public function set backColor(value:StiColor):void

bitmap

property

sti_internal var bitmap:BitmapData = null

border

property

border:StiBorder

Gets or sets frame of the component.

Implementation
public function get border():StiBorder
public function set border(value:StiBorder):void

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 RTF text.

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

defaultColor

property

defaultColor:StiColor

Gets or sets default color.

Implementation
public function get defaultColor():StiColor
public function set defaultColor(value:StiColor):void

defaultFont

property

defaultFont:StiFont

Gets or sets default font.

Implementation
public function get defaultFont():StiFont
public function set defaultFont(value:StiFont):void

detectUrls

property

detectUrls:Boolean

Gets or sets detection of urls.

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

fullConvertExpression

property

fullConvertExpression:Boolean

Gets or sets value which indicates that it is necessary to fully convert the expression to Rtf format. Full convertion of expressions slows down the report rendering.

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

globalizedName

property

globalizedName:String[override]

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

hideZeros

property

hideZeros:Boolean[override]

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

linesOfUnderline

property

linesOfUnderline:int[override]

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

localizedName

property

localizedName:String [read-only] [override]

Gets a localized component name.

Implementation
public function get localizedName():String

margins

property

margins:StiMargins

Gets or sets text margins.

Implementation
public function get margins():StiMargins
public function set margins(value:StiMargins):void

maxNumberOfLines

property

maxNumberOfLines:int[override]

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

page

property

page:StiPage[override]

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

processingDuplicates

property

processingDuplicates:int[override]

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

text

property

text:StiExpression[override]

Gets or sets text expression.

Implementation
public function get text():StiExpression
public function set text(value:StiExpression):void

wordWrap

property

wordWrap:Boolean

Gets or sets word wrap.

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

wysiwyg

property

wysiwyg:Boolean

Gets or sets value which indicates that it is necessary to use the Wysiwyg mode of the rendering.

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

Constructor Detail

StiRichText

()

Constructor

public function StiRichText(rect:StiRectangle = null, text:String)

Parameters

	`rect:StiRectangle` (default = `null`)

	`text:String`

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

clone

()

method

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

Parameters

... args

Returns

Object

equals

()

method

override public function equals(object:Object):Boolean

Parameters

object:Object

Returns

Boolean

getAllStrings

()

method

public function getAllStrings():Array

Returns array of the property names which can be localized.

Returns

Array

getImage

()

method

public function getImage(refZoom:StiRefZoom, format:int = 0):BitmapData

Parameters

	`refZoom:StiRefZoom`

	`format:int` (default = `0`)

Returns

BitmapData

getString

()

method

public function getString(propertyName:String):String

Gets localized string from specified property name.

Parameters

propertyName:String

Returns

String

isExportAsImage

()

method

override public function isExportAsImage(format:int):Boolean

Parameters

format:int

Returns

Boolean

memberwiseClone

()

method

override public function memberwiseClone():Object

Returns

Object

setString

()

method

public function setString(propertyName:String, value:String):void

Sets localized string to specified property name.

Parameters

	`propertyName:String`

	`value:String`

updateComponentImage

()

method

public function updateComponentImage():void

Constant Detail

PropertyCanBreak

Constant

protected static const PropertyCanBreak:Object

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

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

Package	stimulsoft.report.components.simpleComponents
Class	public class StiRichText
Inheritance	StiRichText StiSimpleText StiComponent StiBase StiService StiObject Object
Implements	IStiExportImageExtended, IStiBreakable, IStiBorder, IStiBackColor, IStiGlobalizationProvider
Subclasses	StiTableCellRichText