Package com.stimulsoft.report.dictionary

Class StiUserFunction

java.lang.Object

com.stimulsoft.base.serializing.StiSerializedObject

com.stimulsoft.report.dictionary.StiUserFunction

All Implemented Interfaces:

IStiJsonReportObject, IStiSerializable, IStiSerializableRef

public class StiUserFunction
extends StiSerializedObject
implements IStiSerializable, IStiJsonReportObject

Copyright Stimulsoft

Field Summary

Fields inherited from interface com.stimulsoft.base.serializing.interfaceobject.IStiSerializableRef

REFERENCE_EMPTY, REFERENCE_REPORT

Constructor Summary

Constructors

Constructor	Description
StiUserFunction()
StiUserFunction(String name, StiFunctionCategory category, StiUserFunctionArgumentType returnType)

Method Summary

Modifier and Type	Method	Description
StiUserFunctionArgumentsCollection	getArguments()
StiFunctionCategory	getCategory()
String	getCustomCategory()
String	getDescription()
String	getName()
StiUserFunctionArgumentType	getReturnType()
String	getScriptBlockly()
String	getScriptCSharp()
String	getScriptJS()
StiFunctionScriptMode	getScriptMode()	Deprecated.
String	getScriptVB()
void	LoadFromJsonObject(JSONObject jObject)
JSONObject	SaveToJsonObject(StiJsonSaveMode mode)
void	setArguments(StiUserFunctionArgumentsCollection arguments)
void	setCategory(StiFunctionCategory category)
void	setCustomCategory(String customCategory)
void	setDescription(String description)
void	setName(String name)
void	setReturnType(StiUserFunctionArgumentType returnType)
void	setScriptBlockly(String scriptBlockly)
void	setScriptCSharp(String scriptCSharp)
void	setScriptJS(String scriptJS)
void	setScriptMode(StiFunctionScriptMode scriptMode)	Deprecated.
void	setScriptVB(String scriptVB)

Methods inherited from class com.stimulsoft.base.serializing.StiSerializedObject

cleanReference, getReference, setReference

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

StiUserFunction

public StiUserFunction()

StiUserFunction

public StiUserFunction(String name,
 StiFunctionCategory category,
 StiUserFunctionArgumentType returnType)

Method Details

SaveToJsonObject

public JSONObject SaveToJsonObject(StiJsonSaveMode mode)
                            throws JSONException

Specified by:

SaveToJsonObject in interface IStiJsonReportObject

Throws:

JSONException

LoadFromJsonObject

public void LoadFromJsonObject(JSONObject jObject)
                        throws JSONException

Specified by:

LoadFromJsonObject in interface IStiJsonReportObject

Throws:

JSONException

getName

public String getName()

setName

public void setName(String name)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getCategory

public StiFunctionCategory getCategory()

setCategory

public void setCategory(StiFunctionCategory category)

getCustomCategory

public String getCustomCategory()

setCustomCategory

public void setCustomCategory(String customCategory)

getArguments

public StiUserFunctionArgumentsCollection getArguments()

setArguments

public void setArguments(StiUserFunctionArgumentsCollection arguments)

getReturnType

public StiUserFunctionArgumentType getReturnType()

setReturnType

public void setReturnType(StiUserFunctionArgumentType returnType)

getScriptMode

@Deprecated
public StiFunctionScriptMode getScriptMode()

Deprecated.

setScriptMode

@Deprecated
public void setScriptMode(StiFunctionScriptMode scriptMode)

Deprecated.

getScriptCSharp

public String getScriptCSharp()

setScriptCSharp

public void setScriptCSharp(String scriptCSharp)

getScriptVB

public String getScriptVB()

setScriptVB

public void setScriptVB(String scriptVB)

getScriptJS

public String getScriptJS()

setScriptJS

public void setScriptJS(String scriptJS)

getScriptBlockly

public String getScriptBlockly()

setScriptBlockly

public void setScriptBlockly(String scriptBlockly)