Class StiUserFunction

Hierarchy

StiUserFunction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new StiUserFunction(name?: string, category?: StiFunctionCategory, returnType?: StiUserFunctionArgumentType): StiUserFunction

Parameters
- Default value name: string = ""
- Default value category: StiFunctionCategory = StiFunctionCategory.Programming
- Default value returnType: StiUserFunctionArgumentType = StiUserFunctionArgumentType.String
Returns StiUserFunction

Properties

arguments

arguments: StiUserFunctionArgumentsCollection = new StiUserFunctionArgumentsCollection()

category

category: StiFunctionCategory = StiFunctionCategory.Programming

customCategory

customCategory: string = ""

Gets or sets a category of the function.

description

description: string = ""

Gets or sets a description of the function.

name

name: string = ""

Gets or sets a name of the function.

returnType

returnType: StiUserFunctionArgumentType = StiUserFunctionArgumentType.String

script

script: string = ""

scriptMode

scriptMode: StiFunctionScriptMode = StiFunctionScriptMode.Blocks

Methods

clone

clone(): StiUserFunction

Returns StiUserFunction

getFullScript

getFullScript(language: StiReportLanguageType): string

Parameters
- language: StiReportLanguageType
Returns string

meta

meta(): StiMeta[]

Returns StiMeta[]

Generated using TypeDoc