Reporting

Classes

Class	Description
TXTextControl.DocumentServer.DataShaping.FilterInstruction	The FilterInstruction class is used to filter merge block data by certain conditions before merging.
TXTextControl.DocumentServer.DataShaping.SortingInstruction	The SortingInstruction class contains merge block data sorting information such as the sort order and the column name to sort the data rows after.
TXTextControl.DocumentServer.DataSources.DataColumnInfo	The DataColumnInfo class provides basic information about a table column in a data source.
TXTextControl.DocumentServer.DataSources.DataRelationInfo	The DataRelationInfo class provides all necessary information about parent-child-relations between data tables.
TXTextControl.DocumentServer.DataSources.DataSourceManager	The DataSourceManager class is designed for handling all existing kinds of data sources which can be used together with the MailMerge class.
TXTextControl.DocumentServer.DataSources.DataTableInfo	The DataTableInfo class provides basic information about a data table in a data source.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo	The MergeBlockInfo class is used to insert a table or paragraph based repeating merge block into a TextControl instance using the DataSourceManager.InsertMergeBlock method.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings	The MergeBlockSettings class is used to insert a table or paragraph based repeating merge block into a TextControl instance using the DataSourceManager.InsertMergeBlock method.
TXTextControl.DocumentServer.DataSources.MergeSettings	The MergeSettings class is intended for passing additional settings to the DataSourceManager.Merge method.
TXTextControl.DocumentServer.Windows.Forms.ChartDataRelationDialog	The ChartDataRelationDialog class allows the user to prepare a ChartFrame object to display data from a data relation defined in a mail merge data source.
TXTextControl.DocumentServer.Windows.Forms.DataSourceExtractionDialog	The DataSourceExtractionDialog class allows the user to save an excerpt from the currently loaded data source.
TXTextControl.DocumentServer.Windows.Forms.DatabaseConnectionDialog	The DatabaseConnectionDialog class allows the user to build connection strings and to connect to specific data sources.
TXTextControl.DocumentServer.Windows.Forms.EditDataRelationsDialog	The EditDataRelationsDialog class allows the user to add or remove data relations to or from the current data source.
TXTextControl.DocumentServer.Windows.Forms.EditMergeBlocksDialog	The EditMergeBlocksDialog class allows the user to remove or rename merge blocks contained in the current document.
TXTextControl.DocumentServer.Windows.Forms.FilterAndSortDialog	The FilterAndSortDialog class allows the user to specify filters and sorting instructions for merge blocks.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog	The InsertMergeBlockDialog class allows the user to design and insert a merge block based on the currently selected master table.

Constructors

Constructor	Description
TXTextControl.DocumentServer.DataShaping.FilterInstruction	Initializes a new instance of the FilterInstruction class.
TXTextControl.DocumentServer.DataShaping.SortingInstruction	Initializes a new instance of the SortingInstruction class.
TXTextControl.DocumentServer.DataSources.DataSourceManager	Initializes a new instance of the DataSourceManager class.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo	Initializes a new instance of the MergeBlockInfo class.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings	Initializes a new instance of the MergeBlockSettings class.
TXTextControl.DocumentServer.DataSources.MergeSettings	Initializes a new instance of the MergeSettings class.
TXTextControl.DocumentServer.Windows.Forms.ChartDataRelationDialog	Creates a ChartDataRelationDialog object for the specified DocumentServer.DataSources.DataSourceManager.
TXTextControl.DocumentServer.Windows.Forms.DataSourceExtractionDialog	Creates a DataSourceExtractionDialog object for the specified DocumentServer.DataSources.DataSourceManager.
TXTextControl.DocumentServer.Windows.Forms.DatabaseConnectionDialog	Creates a DatabaseConnectionDialog object for the specified DocumentServer.DataSources.DataSourceManager.
TXTextControl.DocumentServer.Windows.Forms.EditDataRelationsDialog	Creates a EditDataRelationsDialog object for the specified DocumentServer.DataSources.DataSourceManager.
TXTextControl.DocumentServer.Windows.Forms.EditMergeBlocksDialog	Creates a EditMergeBlocksDialog object for the specified DocumentServer.DataSources.DataSourceManager.
TXTextControl.DocumentServer.Windows.Forms.FilterAndSortDialog	Initializes a new instance of the FilterAndSortDialog class.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog	Creates a InsertMergeBlockDialog object for the specified DocumentServer.DataSources.DataSourceManager.

Events

Event	Description
TXTextControl.DocumentServer.DataSources.DataSourceManager.ConnectionStringChanged	Is fired when the contents of the ConnectionString property change.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataProviderNameChanged	Is fired when the contents of the DataProviderName property change.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataRelationsChanged	Is fired when the contents of the DataRelations property change.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataRowMerged	Occurs when a data row has been merged successfully.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataTablesChanged	Is fired when the contents of the DataTables property change.
TXTextControl.DocumentServer.DataSources.DataSourceManager.FieldMerged	Occurs when a field has been merged.
TXTextControl.DocumentServer.DataSources.DataSourceManager.IsMergingPossibleChanged	Is fired when the value of the IsMergingPossible property changes.
TXTextControl.DocumentServer.DataSources.DataSourceManager.MasterDataTableInfoChanged	Is fired when the contents of the MasterDataTableInfo property change.
TXTextControl.DocumentServer.DataSources.DataSourceManager.PossibleMergeBlockTablesChanged	Is fired when the contents of the PossibleMergeBlockTables property change.
TXTextControl.DocumentServer.DataSources.DataSourceManager.PossibleMergeFieldColumnsChanged	Is fired when the contents of the PossibleMergeFieldColumns property change.

Methods

Method	Description
TXTextControl.DocumentServer.DataSources.DataSourceManager.InsertMergeBlock	Inserts a repeating merge block into a TextControl instance, a WPF.TextControl instance or a ServerTextControl instance at the current input position.
TXTextControl.DocumentServer.DataSources.DataSourceManager.IsMergeBlock	Checks if a given SubTextPart is a merge block.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadAssembly	Loads an assembly file as a data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadDataSet	Loads a System.Data.DataSet object as a data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadDataSourceConfig	Loads an XML string or a file containing "report data source configuration" data.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadDataTable	Loads a System.Data.DataTable object as a data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadJson	Loads a JSON string containing an array of objects or a single object as a data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadObjects	Loads a collection implementing the interface IEnumerable as a data source and deduces the data tables, column names and data relations from the public properties and used classes of the first contained object using .NET reflection or, in case of the first contained object being a Dictionary with string keys, from the key names and value types.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadSingleObject	Loads a single object which is either a Dictionary with string keys or an object of an arbitrary type as a data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadXmlFile	Loads the contents of an XML file as a data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.LoadXmlString	Loads XML data, given as a string, as a data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.Merge	Merges a binary TX internal unicode format document with the currently loaded data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.SaveDataSourceConfig	Saves an XML string or a file containing "report data source config" data.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.Apply	Stores the meta data (filters, sorting instructions and the block merging condition) in the SubTextPart which represents the block.
TXTextControl.DocumentServer.Windows.Forms.FilterAndSortDialog.StoreBlockMetaData	Stores filters and sorting instructions created with the dialog in a SubTextPart object if the SubTextPart is a merge block.

Properties

Property	Description
TXTextControl.DocumentServer.DataShaping.FilterInstruction.ColumnName	Gets or sets the name of the table column whose content this merge condition is compared to.
TXTextControl.DocumentServer.DataShaping.FilterInstruction.CompareTo	Gets or sets the value the table column content is compared to using the specified comparison operator.
TXTextControl.DocumentServer.DataShaping.FilterInstruction.ComparisonOperator	Gets or sets the relational operator used as the comparison operator.
TXTextControl.DocumentServer.DataShaping.FilterInstruction.Culture	Gets or sets the format provider for numerical value comparison.
TXTextControl.DocumentServer.DataShaping.FilterInstruction.LogicalOperator	Gets or sets the logical operator by which to logically connect a filter instruction to the previous one if a filter consists of a collection of multiple filter instructions.
TXTextControl.DocumentServer.DataShaping.SortingInstruction.Culture	Gets or sets the format provider for numerical value comparison.
TXTextControl.DocumentServer.DataShaping.SortingInstruction.OrderBy	Gets or sets the table column name to order the data by.
TXTextControl.DocumentServer.DataShaping.SortingInstruction.SortOrder	Gets or sets the sort order (ascending / descending).
TXTextControl.DocumentServer.DataSources.DataColumnInfo.Caption	Gets a descriptive or friendly column name.
TXTextControl.DocumentServer.DataSources.DataColumnInfo.ColumnName	Gets the column name.
TXTextControl.DocumentServer.DataSources.DataColumnInfo.DataTableInfo	Gets an object of type DataTableInfo which represents the table this column belongs to.
TXTextControl.DocumentServer.DataSources.DataColumnInfo.DataType	Gets the data type of this table column.
TXTextControl.DocumentServer.DataSources.DataRelationInfo.ChildColumnName	Gets the name of the child column which is part of this data relation.
TXTextControl.DocumentServer.DataSources.DataRelationInfo.ChildTableName	Gets the name of the child table which is part of this data relation.
TXTextControl.DocumentServer.DataSources.DataRelationInfo.ParentColumnName	Gets the name of the parent column which is part of this data relation.
TXTextControl.DocumentServer.DataSources.DataRelationInfo.ParentTableName	Gets the name of the parent table which is part of this data relation.
TXTextControl.DocumentServer.DataSources.DataRelationInfo.RelationName	Gets the data relation name if one was defined.
TXTextControl.DocumentServer.DataSources.DataSourceManager.ConnectionString	Gets the connection string of the connection selected with the DatabaseConnectionDialog.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataProviderName	Gets the name of the data provider selected with the DatabaseConnectionDialog.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataRelations	Gets a DataRelationInfoCollection of DataRelationInfo objects which represent the data relations in the data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataSourceCulture	Specifies the culture with which numerical and date / time values coming from the data source are parsed.
TXTextControl.DocumentServer.DataSources.DataSourceManager.DataTables	Gets a DataTableInfoCollection of DataTableInfo objects which represent the data tables in the data source.
TXTextControl.DocumentServer.DataSources.DataSourceManager.IsMergingPossible	Gets a value indicating whether all requirements are met and the method Merge can be called.
TXTextControl.DocumentServer.DataSources.DataSourceManager.MasterDataTableInfo	Gets or sets a DataTableInfo object representing the table which is used as a master table when merging data into the document.
TXTextControl.DocumentServer.DataSources.DataSourceManager.MaxMergeResults	Specifies the Upper merge result count.
TXTextControl.DocumentServer.DataSources.DataSourceManager.MergeCulture	Specifies the culture with which numerical and date / time values are formatted when merged into the target document.
TXTextControl.DocumentServer.DataSources.DataSourceManager.PossibleMergeBlockTables	Gets a DataTableInfoCollection of DataTableInfo objects representing the tables which can be used as merge blocks using the currently selected master table.
TXTextControl.DocumentServer.DataSources.DataSourceManager.PossibleMergeFieldColumns	Gets a DataColumnInfoCollection of DataColumnInfo objects representing the table columns which can be used as merge fields using the currently selected master table.
TXTextControl.DocumentServer.DataSources.DataTableInfo.ChildRelations	Gets a DataRelationInfoCollection representing the parent-child-relationships this table has with other data tables.
TXTextControl.DocumentServer.DataSources.DataTableInfo.ChildTables	Gets a DataTableInfoCollection representing the child-tables this table has.
TXTextControl.DocumentServer.DataSources.DataTableInfo.Columns	Gets a DataColumnInfoCollection representing the columns of this data table.
TXTextControl.DocumentServer.DataSources.DataTableInfo.TableName	Gets the table name.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.BlockMergingCondition	Gets or sets a condition the parent data row of this merge block has to satisfy so that this merge block is merged at all.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.ChildBlocks	Gets or sets the list of merge blocks nested inside this merge block.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.ColumnNames	Gets or sets the list of data column names which represent the merge fields this merge block consists of.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.Filters	Gets or sets a list of filter instructions which are used to filter the data rows before merging.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.MergeFields	Returns the merge fields inside this merge block excluding fields in possible nested merge blocks.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.SortingInstructions	Gets or sets a list of sorting instructions which are used to sort the data rows before merging.
TXTextControl.DocumentServer.DataSources.MergeBlockInfo.TableName	Gets the table name of this merge block.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.AddResult	Returns whether the new block has successfully been inserted by DataSourceManager.InsertMergeBlock.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.BlockTemplateType	Gets or sets a value of type BlockTemplateType which specifies the type of the inserted repeating block.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.CreatedTable	Returns the table created by DataSourceManager.InsertMergeBlock if property BlockTemplateType was set to BlockTemplateType.TableRow.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.CreateHeaderRow	If this property is true and property BlockTemplateType is set to BlockTemplateType.TableRow, a table header row is automatically generated.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.FieldDisplayMode	Gets or sets a value of type FieldDisplayMode which specifies the content display mode of the inserted fields.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.HighlightColor	Specifies the color the inserted merge block is highlighted with if the input position is inside the block.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.TableID	Gets or sets the ID of the table created by DataSourceManager.InsertMergeBlock.
TXTextControl.DocumentServer.DataSources.MergeSettings.AsSingleDocument	Specifies whether to combine the merge result to a single document.
TXTextControl.DocumentServer.DataSources.MergeSettings.RemoveEmptyBlocks	Specifies whether the content of empty merge blocks should be removed from the template or not.
TXTextControl.DocumentServer.DataSources.MergeSettings.RemoveEmptyFields	Specifies whether empty fields should be removed from the template or not.
TXTextControl.DocumentServer.DataSources.MergeSettings.RemoveEmptyImages	Specifies whether images which don't have merge data should be removed from the template or not.
TXTextControl.DocumentServer.DataSources.MergeSettings.RemoveEmptyLines	Specifies whether text lines which are empty after merging should be removed from the template or not.
TXTextControl.DocumentServer.DataSources.MergeSettings.RemoveTrailingWhitespace	Specifies whether trailing whitespace should be removed before saving a document.
TXTextControl.DocumentServer.Windows.Forms.DataSourceExtractionDialog.FileName	Returns the file name of the file into which the data source excerpt has been saved.
TXTextControl.DocumentServer.Windows.Forms.DataSourceExtractionDialog.MaxRows	Returns the maximum number of data rows from the selected table which were saved into the excerpt file.
TXTextControl.DocumentServer.Windows.Forms.DataSourceExtractionDialog.SelectedTable	Returns a description of the table which was selected by the user to be exported.
TXTextControl.DocumentServer.Windows.Forms.FilterAndSortDialog.Filters	Gets the filter instructions which were created using the dialog or sets the filter instructions which are shown when the dialog is opened.
TXTextControl.DocumentServer.Windows.Forms.FilterAndSortDialog.SortingInstructions	Gets the sorting instructions which were created using the dialog or sets the sorting instructions which are shown when the dialog is opened.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog.AddResult	Returns whether the new block has successfully been inserted.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog.AddTableHeaderRow	Indicates whether a separate header row has to be added to the table containing the repeating merge block.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog.BlockType	Indicates the type of the merge block to be created.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog.CreatedTable	Returns the newly created TXTextControl.Table if the merge block was inserted as a table row.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog.HighlightColor	Returns the selected highlight color to be used for the sub text part representing the merge block.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog.MergeBlockInfo	Returns a MergeBlockInfo object describing the merge block to be inserted.