Interface IDataExtension

Namespace: BoldReports.Data

Assembly: BoldReports.Web.dll

Syntax

public interface IDataExtension

Properties

Command

Gets or sets the command associated with this instance.

Declaration

Command Command { get; set; }

Property Value

Type	Description
BoldReports.Data.Command	An object of type Command representing the command configuration or executable command to be used.

ConnectionProperties

Gets or sets the connection properties associated with this instance.

Declaration

ConnectionProperties ConnectionProperties { get; set; }

Property Value

Type	Description
BoldReports.Data.ConnectionProperties	An object of type ConnectionProperties representing the configuration details required for a connection.

CustomProperties

Gets or sets the custom properties associated with this instance.

Declaration

Dictionary<string, object> CustomProperties { get; set; }

Property Value

Type	Description
System.Collections.Generic.Dictionary<System.String, System.Object>	A dictionary where the keys are strings representing property names and the values are objects representing the property values.

DataSet

Gets or sets the dataset associated with this instance.

Declaration

DataSet DataSet { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.DataSet	The dataset of type BoldReports.RDL.DOM.DataSet which contains the data structure and data used in the report.

DataSource

Gets or sets the data source associated with this instance.

Declaration

DataSource DataSource { get; set; }

Property Value

Type	Description
BoldReports.RDL.DOM.DataSource	An object of type DataSource representing the data source configuration or connection to be used.

Helper

Gets or sets the helper associated with this instance for providing utility functions or extensions.

Declaration

ExtensionHelper Helper { get; set; }

Property Value

Type	Description
BoldReports.Web.ExtensionHelper	An instance of ReportingCommon.ExtensionHelper which provides additional support and utility methods for this instance.

IsDesignerMode

Gets or sets a value indicating whether the instance is in designer mode.

Declaration

bool IsDesignerMode { get; set; }

Property Value

Type	Description
System.Boolean	A boolean value where true indicates that the instance is in designer mode and false indicates otherwise.

QueryBuilderModel

Gets or sets the query builder model associated with this instance.

Declaration

QueryBuilderModel QueryBuilderModel { get; set; }

Property Value

Type	Description
BoldReports.Data.QueryBuilderModel

Methods

add_EvaluateExpression(EvaluateExpressionEventHandler)

Declaration

void add_EvaluateExpression(EvaluateExpressionEventHandler value)

Parameters

Type	Name	Description
EvaluateExpressionEventHandler	value

add_ParseExpression(ParseExpressionEventHandler)

Declaration

void add_ParseExpression(ParseExpressionEventHandler value)

Parameters

Type	Name	Description
ParseExpressionEventHandler	value

GenerateQuery(QueryBuilderModel)

Generates a query based on the provided query builder model and outputs an error message if generation fails.

Declaration

string GenerateQuery(QueryBuilderModel queryBuilderModel)

Parameters

Type	Name	Description
BoldReports.Data.QueryBuilderModel	queryBuilderModel

Returns

Type	Description
System.String

GetCommandText(QueryBuilderDesignInfo, out String)

Constructs a command text based on the provided design information.

Declaration

string GetCommandText(QueryBuilderDesignInfo designInfo, out string errorMessage)

Parameters

Type	Name	Description
BoldReports.Data.QueryBuilderDesignInfo	designInfo	The design info used for building the query.
System.String	errorMessage	An output parameter that contains an error message if the command text cannot be generated successfully.

Returns

Type	Description
System.String	A string representing the SQL command text constructed from the design information.

GetData(out String)

Retrieves data and outputs an error message if one occurs.

Declaration

object GetData(out string errorMessage)

Parameters

Type	Name	Description
System.String	errorMessage

Returns

Type	Description
System.Object	The retrieved data object.

GetDatabases(out String)

Retrieves a list of databases as a DataTable and provides an error message if retrieval fails.

Declaration

DataTable GetDatabases(out string errorMessage)

Parameters

Type	Name	Description
System.String	errorMessage	An output parameter that contains an error message if the databases cannot be retrieved successfully.

Returns

Type	Description
System.Data.DataTable	A DataTable containing the list of databases.

GetDataOnDemand(out String, Int64, Int64)

Retrieves the table columns based on the provided schema data.

Declaration

object GetDataOnDemand(out string errorMessage, long batchStartRowNumber = 0L, long maxRowsPerBatch = 0L)

Parameters

Type	Name	Description
System.String	errorMessage	Outputs an error message if the operation fails.
System.Int64	batchStartRowNumber	The starting index for retrieving data. Defaults to 0.
System.Int64	maxRowsPerBatch

Returns

Type	Description
System.Object	A dictionary mapping table names to their respective objects containing the table column information.

GetDataSourceSchema(SchemaDataInfo, out String)

Retrieves the schema for the data source based on the provided schema information.

Declaration

SchemaData GetDataSourceSchema(SchemaDataInfo schemaData, out string errorMessage)

Parameters

Type	Name	Description
BoldReports.Data.SchemaDataInfo	schemaData	An object containing information about the schema to be retrieved.
System.String	errorMessage	An output parameter that will contain an error message if the schema retrieval fails, or will be empty if the retrieval is successful.

Returns

Type	Description
BoldReports.Data.SchemaData	A BoldReports.Data.SchemaData object that represents the schema of the data source. If the retrieval is unsuccessful, the returned object may be null or incomplete.

GetQuerySchema(out String)

Retrieves the schema of a query and provides an error message if retrieval fails.

Declaration

object GetQuerySchema(out string errorMessage)

Parameters

Type	Name	Description
System.String	errorMessage	An output parameter that contains an error message if the schema cannot be retrieved successfully.

Returns

Type	Description
System.Object	An object representing the query schema.

GetTableColumns(List<SchemaDataInfo>, out String)

Retrieves the table columns based on the provided schema data.

Declaration

Dictionary<string, SchemaData> GetTableColumns(List<SchemaDataInfo> schemaData, out string errorMessage)

Parameters

Type	Name	Description
System.Collections.Generic.List<BoldReports.Data.SchemaDataInfo>	schemaData	A list of BoldReports.Data.SchemaDataInfo objects representing the schema data.
System.String	errorMessage	Outputs an error message if the operation fails.

Returns

Type	Description
System.Collections.Generic.Dictionary<System.String, BoldReports.Data.SchemaData>	A dictionary mapping table names to their respective BoldReports.Data.SchemaData containing the table column information.

remove_EvaluateExpression(EvaluateExpressionEventHandler)

Declaration

void remove_EvaluateExpression(EvaluateExpressionEventHandler value)

Parameters

Type	Name	Description
EvaluateExpressionEventHandler	value

remove_ParseExpression(ParseExpressionEventHandler)

Declaration

void remove_ParseExpression(ParseExpressionEventHandler value)

Parameters

Type	Name	Description
ParseExpressionEventHandler	value

RemoveQueryTable(QueryJoinerInfo, out String)

Removes a query table based on the provided joiner information.

Declaration

RemoveTableData RemoveQueryTable(QueryJoinerInfo joinerInfo, out string error)

Parameters

Type	Name	Description
BoldReports.Data.QueryJoinerInfo	joinerInfo	An instance of BoldReports.Data.QueryJoinerInfo containing data about the query join to be removed.
System.String	error	An output parameter that will contain any error message if the operation fails.

Returns

Type	Description
BoldReports.Data.RemoveTableData	An instance of BoldReports.Data.RemoveTableData representing the result of the remove operation.

TestConnection(out String)

Tests the connection and determines if it is successful or not.

Declaration

bool TestConnection(out string errorMessage)

Parameters

Type	Name	Description
System.String	errorMessage	Outputs an error message if the connection test fails.

Returns

Type	Description
System.Boolean	True if the connection is successful; otherwise, false.

ValidateAutoJoin(List<String>, out String)

Validates the automatic join conditions between the provided table names.

Declaration

List<Joiner> ValidateAutoJoin(List<string> tableNames, out string errorMessage)

Parameters

Type	Name	Description
System.Collections.Generic.List<System.String>	tableNames	A list of table names to be validated for automatic joining.
System.String	errorMessage	An output parameter that value an error message detailing any issues encountered during validation. If the validation is successful, this will be null or empty.

Returns

Type	Description
System.Collections.Generic.List<BoldReports.Data.Joiner>	A list of BoldReports.Data.Joiner objects, representing the join conditions determined to be valid.

ValidateTableRelations(List<Joiner>, out String)

Validates the automatic join conditions for a list of table names.

Declaration

List<Joiner> ValidateTableRelations(List<Joiner> joins, out string errorMessage)

Parameters

Type	Name	Description
System.Collections.Generic.List<BoldReports.Data.Joiner>	joins
System.String	errorMessage	Outputs an error message if validation fails.

Returns

Type	Description
System.Collections.Generic.List<BoldReports.Data.Joiner>	A list of Joiner objects representing the validated and established joins.

Events

EvaluateExpression

Occurs when an expression needs to be evaluated during reporting.

Declaration

event EvaluateExpressionEventHandler EvaluateExpression

Event Type

Type	Description
EvaluateExpressionEventHandler	The event handler that manages the evaluation of expressions.

ParseExpression

Occurs when an expression is being parsed.

Declaration

event ParseExpressionEventHandler ParseExpression

Event Type

Type	Description
ParseExpressionEventHandler	The event handler for parsing expressions within ReportingCommon.