StiNameCreation Class

Namespace: Stimulsoft.Report

Describes the class that used for report names creation.

Methods

Method Details

CreateCategoryOfVariableName static

CreateCategoryOfVariableName(report: StiReport, baseName: string): string

Creates a category name for a variable in the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the category name is being created.
• baseName (string) — The base name to process. If null, a default name is used.

Returns string — The generated category name.

CreateColumnName static

CreateColumnName(dataSource: StiDataSource, baseName: string): string

Creates a column name for the data source by removing spaces and ensuring uniqueness.

Parameters

• dataSource (StiDataSource) — The data source object for which the column name is being created.
• baseName (string) — The base name to process. If null, a default name is used.

Returns string — The generated column name.

CreateConnectionName static

CreateConnectionName(report: StiReport, baseName: string): string

Creates a connection name for the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the connection name is being created.
• baseName (string) — The base name to process.

Returns string — The generated connection name.

CreateDataSourcesName static

CreateDataSourcesName(report: StiReport, baseName: string): string

Creates a name for the data sources in the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the data source name is being created.
• baseName (string) — The base name to process.

Returns string — The generated data source name.

CreateName static

CreateName(report: StiReport, baseName: string): string

Creates a name from the base name which is correct for the report.

Parameters

• report (StiReport) — Report.
• baseName (string) — The type to form a name.

Returns string

CreateName(report: StiReport, baseName: string, addOne: bool, removeIncorrectSymbols: bool): string

Creates a name from the base name which is correct for the report.

Parameters

• report (StiReport) — The report object for which the name is being created.
• baseName (string) — The base name to process.
• addOne (bool) — Indicates whether to add the number one to the base name.
• removeIncorrectSymbols (bool) — Indicates whether to remove incorrect symbols from the base name.

Returns string — The generated name.

CreateName(report: StiReport, baseName: string, addOne: bool, removeIncorrectSymbols: bool, forceAdvancedNamingRule: bool): string

Creates a name from the base name which is correct for the report.

Parameters

• report (StiReport) — Report.
• baseName (string) — The type to form a name.
• addOne (bool)
• removeIncorrectSymbols (bool)
• forceAdvancedNamingRule (bool)

Returns string

CreateParameterName static

CreateParameterName(dataSource: StiSqlSource, baseName: string): string

Creates a parameter name for the given SQL source by removing spaces and ensuring uniqueness.

Parameters

• dataSource (StiSqlSource) — The SQL source object for which the parameter name is being created.
• baseName (string) — The base name to process. If null, a default name is used.

Returns string — The generated parameter name.

CreateRelationName static

CreateRelationName(report: StiReport, dataRelation: StiDataRelation, baseName: string): string

Creates a relation name for the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the relation name is being created.
• dataRelation (StiDataRelation) — The data relation object for which the name is being created.
• baseName (string) — The base name to process.

Returns string — The generated relation name.

CreateRelationName(report: StiReport, baseName: string): string

Creates a relation name for the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the relation name is being created.
• baseName (string) — The base name to process. If null, a default name is used.

Returns string — The generated relation name.

CreateResourceName static

CreateResourceName(report: StiReport, baseName: string): string

Creates a resource name for the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the resource name is being created.
• baseName (string) — The base name to process. If null, a default name is used.

Returns string — The generated resource name.

CreateSimpleName static

CreateSimpleName(report: StiReport, baseName: string): string

Creates a simple name for the report by removing spaces and adding an index.

Parameters

• report (StiReport) — The report object for which the name is being created.
• baseName (string) — The base name to process.

Returns string — The generated simple name.

CreateUserFunctionName static

CreateUserFunctionName(report: StiReport, baseName: string): string

Creates a user function name for the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the user function name is being created.
• baseName (string) — The base name to process. If null, a default name is used.

Returns string — The generated user function name.

CreateVariableName static

CreateVariableName(report: StiReport, baseName: string): string

Creates a variable name for the report by removing spaces and ensuring uniqueness.

Parameters

• report (StiReport) — The report object for which the variable name is being created.
• baseName (string) — The base name to process. If null, a default name is used.

Returns string — The generated variable name.

Exists static

Exists(checkedObject: object, report: StiReport, name: string): bool

Checks if an object with the specified name exists in the report.

Parameters

• checkedObject (object) — The object to check.
• report (StiReport) — The report object to check within.
• name (string) — The name to check for.

Returns bool — True if an object with the specified name exists, otherwise false.

Exists(report: StiReport, name: string): bool

Checks if an object with the specified name exists in the report.

Parameters

• report (StiReport) — The report object to check within.
• name (string) — The name to check for.

Returns bool — True if an object with the specified name exists, otherwise false.

GenerateName static

GenerateName(report: StiReport, localizedName: string, name: string): string

Returns a name of the component.

Parameters

• report (StiReport)
• localizedName (string) — Localized component name.
• name (string) — Did not localized component name.

Returns string — Component name.

GenerateName(report: StiReport, localizedName: string, type: Type): string

Returns a name of the component.

Parameters

• report (StiReport)
• localizedName (string) — Localized component name.
• type (Type) — Type of component.

Returns string — Component name.

GenerateName(component: StiComponent): string

Returns a name for the component.

Parameters

• component (StiComponent) — Component for which a name is created.

Returns string — Component name.

GenerateName(relation: StiDataRelation): string

Returns a name for the relation.

Parameters

• relation (StiDataRelation) — Relation for which a name is created.

Returns string — Relation name.

GenerateName(dataSource: StiDataSource): string

Returns a name for the datasource.

Parameters

• dataSource (StiDataSource) — Datasource for which a name is created.

Returns string — Datasource name.

GetObjectWithName static

GetObjectWithName(checkedObject: object, report: StiReport, name: string): object

Gets the object with the specified name in the report.

Parameters

• checkedObject (object) — The object to check.
• report (StiReport) — The report object to check within.
• name (string) — The name to check for.

Returns object — The object with the specified name, or null if not found.

IsCategoryOfVariableNameExists static

IsCategoryOfVariableNameExists(report: StiReport, name: string): bool

Checks if a category with the specified name exists in the report’s variables.

Parameters

• report (StiReport) — The report object to check.
• name (string) — The name of the category to check.

Returns bool — True if the category exists, otherwise false.

IsColumnNameExists static

IsColumnNameExists(dataSource: StiDataSource, name: string): bool

Checks if a column with the specified name exists in the data source.

Parameters

• dataSource (StiDataSource) — The data source object to check.
• name (string) — The name of the column to check.

Returns bool — True if the column exists, otherwise false.

IsConnectionNameExists static

IsConnectionNameExists(report: StiReport, name: string): bool

Checks if a connection with the specified name exists in the report.

Parameters

• report (StiReport) — The report object to check.
• name (string) — The name of the connection to check.

Returns bool — True if the connection exists, otherwise false.

IsParameterNameExists static

IsParameterNameExists(dataSource: StiSqlSource, name: string): bool

Checks if a parameter with the specified name exists in the SQL source.

Parameters

• dataSource (StiSqlSource) — The SQL source object to check.
• name (string) — The name of the parameter to check.

Returns bool — True if the parameter exists, otherwise false.

IsRelationExists static

IsRelationExists(report: StiReport, dataRelation: StiDataRelation, name: string): bool

Checks if a relation with the specified name exists in the report.

Parameters

• report (StiReport) — The report object to check.
• dataRelation (StiDataRelation) — The data relation object to compare.
• name (string) — The name of the relation to check.

Returns bool — True if the relation exists, otherwise false.

IsResourceNameExists static

IsResourceNameExists(report: StiReport, name: string): bool

Checks if a resource with the specified name exists in the report.

Parameters

• report (StiReport) — The report object to check.
• name (string) — The name of the resource to check.

Returns bool — True if the resource exists, otherwise false.

IsTableDataSourcesExists static

IsTableDataSourcesExists(report: StiReport, name: string): bool

Checks if a data source with the specified name exists in the report.

Parameters

• report (StiReport) — The report object to check.
• name (string) — The name of the data source to check.

Returns bool — True if the data source exists, otherwise false.

IsValidName static

IsValidName(report: StiReport, name: string): bool

Checks whether the name of the report is correct.

Parameters

• report (StiReport)
• name (string) — Checked name.

Returns bool — Result of checking.