StiFunction Class
Namespace: Stimulsoft.Report.Dictionary
Inheritance
Implements: IComparable, IStiAppFunction
Constructors
| Constructor | Description |
|---|---|
| constructor(string category, string groupFunctionName, string functionName, string description, string typeOfFunction, Type returnType, any returnDescription, Type[] argumentTypes, string[] argumentNames, string[] argumentDescriptions) |
constructor(category: string, groupFunctionName: string, functionName: string, description: string, typeOfFunction: string, returnType: Type, returnDescription: any, argumentTypes: Type[], argumentNames: string[], argumentDescriptions: string[])
Parameters
- category (string)
- groupFunctionName (string)
- functionName (string)
- description (string)
- typeOfFunction (string)
- returnType (Type)
- returnDescription (any)
- argumentTypes (Type[])
- argumentNames (string[])
- argumentDescriptions (string[])
Properties
| Property | Type | Description |
|---|---|---|
| argumentDescriptions | string[] | |
| argumentNames | string[] | |
| argumentTypes | Type[] |
Methods
| Method | Returns | Description |
|---|---|---|
| compareTo | number | |
| convertTypeToString | string | |
| getFunctionString | string | |
| getKey | string | |
| getLongFunctionString | string | |
| getName | string | |
| implements | any[] | |
| invoke | any | |
| setKey | void | |
| toString | string |
Method Details
compareTo
compareTo(func: StiFunction): number
Parameters
- func (StiFunction)
Returns number
convertTypeToString
convertTypeToString(typeT: Type, language: StiReportLanguageType): string
Parameters
- typeT (Type)
- language (StiReportLanguageType)
Returns string
getFunctionString
getFunctionString(language: StiReportLanguageType, addFunctionName: any): string
Parameters
- language (StiReportLanguageType)
- addFunctionName (any)
Returns string
getKey
getKey(): string
Returns string
getLongFunctionString
getLongFunctionString(language: StiReportLanguageType): string
Parameters
- language (StiReportLanguageType)
Returns string
getName
getName(): string
Returns string
implements
implements(): any[]
Returns any[]
invoke
invoke(args: any[]): any
Parameters
- args (any[])
Returns any
setKey
setKey(key: string): void
Parameters
- key (string)
toString
toString(): string
Returns string
Fields
| Field | Type | Description |
|---|---|---|
| category | any | |
| description | any | |
| functionName | any | |
| groupFunctionName | any | |
| jsFunction | Function | |
| key | any | |
| returnDescription | any | |
| returnType | Type | |
| typeOfFunction | string | |
| useFullPath | any |