stimulsoft.report.dictionary.StiVariable

	Property	Defined By
		alias : String Gets or sets an alias of the variable.	StiVariable
		allowUseAsSqlParameter : Boolean Gets or sets a value which allows using this variable as a SQL parameter in the query.	StiVariable
		applyFormat : Boolean [override] [read-only]	StiVariable
		category : String Gets or sets a category of the the variable.	StiVariable
		description : String Gets or sets a description of the variable.	StiVariable
		dialogInfo : StiDialogInfo Gets or sets a dialog info of the variable.	StiVariable
		fullConvert : Boolean [read-only]	StiExpression
		functionn : Boolean Gets or sets a value which indicates that this variable will be have defalt value based on calculation of expression which specified in Value property.	StiVariable
		genAddEvent : Boolean [read-only]	StiExpression
		inherited : Boolean	StiVariable
		initBy : int Gets or sets a value which indicates that this variable will be have defalt value based on calculation of expression which specified in Value property or based on default value.	StiVariable
		initByExpressionFrom : String Gets or sets init by expression for range values.	StiVariable
		initByExpressionTo : String Gets or sets init by expression for range values.	StiVariable
		isDefault : Boolean [override] [read-only]	StiVariable
		key : String Gets or sets the key of the dictionary object.	StiVariable
		name : String Gets or sets a name of the variable.	StiVariable
		parentComponent : Object = null	StiExpression
		readOnly : Boolean Gets or sets a value which indicates that this variable is read only.	StiVariable
		requestFromUser : Boolean Gets or sets a request from user value which indicates that this variable will be requested from user.	StiVariable
		selection : int	StiVariable
		type : int Gets or sets type of the variable.	StiVariable
		value : String [override]	StiVariable
		valueObject : Object	StiVariable

	Method	Defined By
		StiVariable(category:String, name:String, alias:String, type:int = 18, value:String, readOnly:Boolean = false, initBy:int = 0, requestFromUser:Boolean = false, dialogInfo:StiDialogInfo = null, key:String = null, allowUseAsSqlParameter:Boolean = false, selection:int = 0)	StiVariable
		clone(... args):Object [override]	StiExpression
		deserialize(value:String):void [override]	StiVariable
		equals(object:Object):Boolean [override]	StiVariable
		getDefaultEvent():StiEvent	StiExpression
		getShortTypeName():String Get a short object type name (without library path).	StiObject
		getType():Class	StiObject
		getTypeName():String	StiObject
		getValue(str:String, type:int):Object [static] Internal use only.	StiVariable
		isSimple(object:*):Boolean [static]	StiObject
		memberwiseClone():Object [override]	StiVariable
		serialize():String [override]	StiVariable
		setValue(value:Object):void Internal use only.	StiVariable
		toString():String	StiExpression

Property Detail

alias

property

alias:String

Gets or sets an alias of the variable.

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

allowUseAsSqlParameter

property

allowUseAsSqlParameter:Boolean

Gets or sets a value which allows using this variable as a SQL parameter in the query.

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

applyFormat

property

applyFormat:Boolean [read-only] [override]

Implementation
public function get applyFormat():Boolean

category

property

category:String

Gets or sets a category of the the variable.

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

description

property

description:String

Gets or sets a description of the variable.

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

dialogInfo

property

dialogInfo:StiDialogInfo

Gets or sets a dialog info of the variable.

Implementation
public function get dialogInfo():StiDialogInfo
public function set dialogInfo(value:StiDialogInfo):void

functionn

property

functionn:Boolean

Gets or sets a value which indicates that this variable will be have defalt value based on calculation of expression which specified in Value property. The property is obsolete. Please use 'initBy' property instead it.

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

inherited

property

inherited:Boolean

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

initBy

property

initBy:int

Gets or sets a value which indicates that this variable will be have defalt value based on calculation of expression which specified in Value property or based on default value.

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

initByExpressionFrom

property

initByExpressionFrom:String

Gets or sets init by expression for range values. This is expression for From part of range. Property can be used only for Range types!

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

initByExpressionTo

property

initByExpressionTo:String

Gets or sets init by expression for range values. This is expression for To part of range. Property can be used only for Range types!

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

isDefault

property

isDefault:Boolean [read-only] [override]

Implementation
public function get isDefault():Boolean

key

property

key:String

Gets or sets the key of the dictionary object.

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

name

property

name:String

Gets or sets a name of the variable.

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

readOnly

property

readOnly:Boolean

Gets or sets a value which indicates that this variable is read only.

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

requestFromUser

property

requestFromUser:Boolean

Gets or sets a request from user value which indicates that this variable will be requested from user.

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

selection

property

selection:int

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

type

property

type:int

Gets or sets type of the variable.

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

value

property

value:String[override]

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

valueObject

property

valueObject:Object

Implementation
public function get valueObject():Object
public function set valueObject(value:Object):void

Constructor Detail

StiVariable

()

Constructor

public function StiVariable(category:String, name:String, alias:String, type:int = 18, value:String, readOnly:Boolean = false, initBy:int = 0, requestFromUser:Boolean = false, dialogInfo:StiDialogInfo = null, key:String = null, allowUseAsSqlParameter:Boolean = false, selection:int = 0)

Parameters

	`category:String`

	`name:String`

	`alias:String`

	`type:int` (default = `18`)

	`value:String`

	`readOnly:Boolean` (default = `false`)

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

	`requestFromUser:Boolean` (default = `false`)

	`dialogInfo:StiDialogInfo` (default = `null`)

	`key:String` (default = `null`)

	`allowUseAsSqlParameter:Boolean` (default = `false`)

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

Method Detail

deserialize

()

method

override public function deserialize(value:String):void

Parameters

value:String

equals

()

method

override public function equals(object:Object):Boolean

Parameters

object:Object

Returns

Boolean

getValue

()

method

public static function getValue(str:String, type:int):Object

Internal use only.

Parameters

	`str:String`

	`type:int`

Returns

Object

memberwiseClone

()

method

override public function memberwiseClone():Object

Returns

Object

serialize

()

method

override public function serialize():String

Returns

String

setValue

()

method

public function setValue(value:Object):void

Internal use only.

Parameters

value:Object

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

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

Package	stimulsoft.report.dictionary
Class	public class StiVariable
Inheritance	StiVariable StiExpression StiObject Object
Implements	IStiName, IStiInherited