New Classes, Properties, Methods and Events for Windows Forms

In TX Text Control 24.0 for Windows Forms the following new classes, properties, methods and events have been added:

Classes

Class Description
TXTextControl.DocumentServer.DataSources.DataColumnInfo The DataColumnInfo class provides basic information about a table column in a data source.
TXTextControl.DocumentServer.DataSources.DataColumnInfoCollection An instance of the DataColumnInfoCollection class contains all data columns of a data table in a data source represented through objects of the type DataColumnInfo.
TXTextControl.DocumentServer.DataSources.DataRelationInfo The DataRelationInfo class provides all necessary information about parent-child-relations between data tables.
TXTextControl.DocumentServer.DataSources.DataRelationInfoCollection An instance of the DataRelationInfoCollection class contains all data relations in a data source represented through objects of the type DataRelationInfo.
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.DataTableInfoCollection An instance of the DataTableInfoCollection class contains all data tables in a data source represented through objects of the type DataTableInfo.
TXTextControl.DocumentServer.DataSources.InsertMergeBlockSettings The InsertMergeBlockSettings 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.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.Json.InvalidCodePointException Is thrown when calling method MailMerge.MergeJsonData with a JSON string containing an invalid hexadecimal unicode code point.
TXTextControl.DocumentServer.Json.InvalidNumberFormatException Is thrown when calling method MailMerge.MergeJsonData with a JSON string containing a number with an invalid number format.
TXTextControl.DocumentServer.Json.ParserException Base class of all JSON parser related exceptions which can be thrown when calling method MailMerge.MergeJsonData with an incorrect JSON string.
TXTextControl.DocumentServer.Json.UnexpectedEndOfInputException Is thrown when calling method MailMerge.MergeJsonData with an incomplete JSON string.
TXTextControl.DocumentServer.Json.UnexpectedTokenException Is thrown when calling method MailMerge.MergeJsonData with a JSON string containing an unexpected character.
TXTextControl.DocumentServer.Json.UnknownLiteralNameTokenException Is thrown when calling method MailMerge.MergeJsonData with a JSON string containing an unknown character sequence at a position where one of the strings "true", "false" or "null" are expected.
TXTextControl.DocumentServer.Json.UnknownParseErrorException Is thrown when calling method MailMerge.MergeJsonData and the internal JSON parser encounters an unknown error.
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.DataSourceExtractionDialog The DataSourceExtractionDialog class allows the user to save an excerpt from the currently loaded data source.
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.InsertMergeBlockDialog The InsertMergeBlockDialog class allows the user to design and insert a merge block based on the currently selected master table.
TXTextControl.Drawing.ViewChangedEventArgs The ViewChangedEventArgs class provides data for the TXDrawingControl.ViewChanged event.
TXTextControl.FilterException The FilterException class informs about errors which can occur when a text filter is used to convert a document to or from another format.
TXTextControl.FrameEventArgs The FrameEventArgs class provides data for all events that occur with frames.
TXTextControl.LicenseLevelException A LicenseLevelException is thrown when a feature is not contained in the currently licensed product level.
TXTextControl.PaperSize The PaperSize class is used with the TextControl.GetSupportedPaperSizes and WPF.TextControl.GetSupportedPaperSizes methods, which return the names and the sizes of all currently supported paper sizes.
TXTextControl.TextEditorException The TextEditorException class informs about errors which can occur during editing text.
TXTextControl.UserDefinedPropertyDictionary An instance of the UserDefinedPropertyDictionary class contains all user-defined document properties contained in a loaded document or which will be saved in a document.
TXTextControl.Windows.Forms.Ribbon.ContextualTabGroup An object of the ContextualTabGroup class represents a group of ribbon tabs which are only shown in a certain context.
TXTextControl.Windows.Forms.Ribbon.ContextualTabGroupCollection The ContextualTabGroupCollection class represents all groups of ribbon tabs which are only shown in a certain context.
TXTextControl.Windows.Forms.Ribbon.HorizontalRibbonGroup The HorizontalRibbonGroup class represents a logical group of controls as they appear on a RibbonTab.
TXTextControl.Windows.Forms.Ribbon.Ribbon The Ribbon class is a command bar that organizes the features of an application into a series of tabs at the top of the application window.
TXTextControl.Windows.Forms.Ribbon.Ribbon.Colors The Ribbon.Colors class gets, sets or resets the display colors of a Windows Forms Ribbon control.
TXTextControl.Windows.Forms.Ribbon.RibbonButton The RibbonButton class is a button control which can be added to a RibbonGroup or to a RibbonMenuButton where it is stored as an item of the drop-down menu.
TXTextControl.Windows.Forms.Ribbon.RibbonComboBox The RibbonComboBox class represents a combobox which is inherited from the System.Windows.Forms.ComboBox class.
TXTextControl.Windows.Forms.Ribbon.RibbonForm The RibbonForm class represents a Windows Forms form that can draw a Ribbon Quick Access Toolbar and contextual tabs in its border.
TXTextControl.Windows.Forms.Ribbon.RibbonFormattingTab The RibbonFormattingTab class represents a ribbon tab for setting font and paragraph attributes, formatting styles and for handling the clipboard.
TXTextControl.Windows.Forms.Ribbon.RibbonFrameLayoutTab The RibbonFrameLayoutTab class represents a Windows Forms ribbon tab for editing objects of type Image, TextFrame, DrawingFrame, BarcodeFrame and ChartFrame.
TXTextControl.Windows.Forms.Ribbon.RibbonGroup The RibbonGroup class represents a logical group of controls as they appear on a RibbonTab and is the base class of the HorizontalRibbonGroup class.
TXTextControl.Windows.Forms.Ribbon.RibbonGroup.DialogBoxLauncher The DialogBoxLauncher class represents the dialog box launcher item of a RibbonGroup.
TXTextControl.Windows.Forms.Ribbon.RibbonGroupCollection An instance of the RibbonGroupCollection class contains objects of type RibbonGroup and can be obtained with the RibbonTab.RibbonGroups property.
TXTextControl.Windows.Forms.Ribbon.RibbonInsertTab The RibbonInsertTab class represents a Windows Forms ribbon tab for inserting pages, images, hyperlinks, bookmarks, headers and footers, textframes and symbols.
TXTextControl.Windows.Forms.Ribbon.RibbonItemCollection An instance of the RibbonItemCollection class contains controls of type RibbonButton, RibbonComboBox, RibbonLabel, RibbonListView, RibbonTextBox or RibbonSeperator and can be obtained with the RibbonGroup.RibbonItems, Ribbon.ApplicationMenuHelpPaneItems, Ribbon.ApplicationMenuItems, RibbonMenuButton.DropDownItems or RibbonListView.DropDownItems property.
TXTextControl.Windows.Forms.Ribbon.RibbonLabel The RibbonLabel class represents a label which is inherited from the System.Windows.Forms.Control class.
TXTextControl.Windows.Forms.Ribbon.RibbonListView The RibbonListView class is a list view control, which displays a collection of items that can be displayed using one of three different views.
TXTextControl.Windows.Forms.Ribbon.RibbonListView.RibbonListViewItem The RibbonListViewItem class represents an item in a RibbonListView control.
TXTextControl.Windows.Forms.Ribbon.RibbonListView.RibbonListViewItemCollection An instance of the RibbonListViewItemCollection class contains controls of type RibbonListViewItem and can be obtained with the RibbonListView.RibbonListViewItems property.
TXTextControl.Windows.Forms.Ribbon.RibbonListView.RibbonListViewItemEventArgs The RibbonListViewItemEventArgs class provides data for the RibbonListView.ItemClick, ItemMouseEnter or ItemMouseLeave event.
TXTextControl.Windows.Forms.Ribbon.RibbonMenuButton The RibbonMenuButton class is a button control that displays a drop-down menu when clicked.
TXTextControl.Windows.Forms.Ribbon.RibbonPageLayoutTab The RibbonPageLayoutTab class represents a Windows Forms ribbon tab for editing the page setup and layout.
TXTextControl.Windows.Forms.Ribbon.RibbonProofingTab The RibbonProofingTab class represents a Windows Forms ribbon tab for setting proofing options such as spelling, hyphenation or language settings.
TXTextControl.Windows.Forms.Ribbon.RibbonReportingTab The RibbonReportingTab class represents a Windows Forms ribbon tab to integrate mail merge and reporting functionality.
TXTextControl.Windows.Forms.Ribbon.RibbonSeperator The RibbonSeperator class represents a control that provides a seperator between elements in a HorizontalRibbonGroup, an ApplicationMenu or a drop-down menu of a RibbonMenuButton.
TXTextControl.Windows.Forms.Ribbon.RibbonSplitButton The RibbonSplitButton class is a control that has a primary button that responds to a Click event and a secondary button that displays a drop-down menu when clicked.
TXTextControl.Windows.Forms.Ribbon.RibbonTab The RibbonTab class represents a tab in a Ribbon.
TXTextControl.Windows.Forms.Ribbon.RibbonTableLayoutTab The RibbonTableLayoutTab class represents a Windows Forms ribbon tab for editing tables.
TXTextControl.Windows.Forms.Ribbon.RibbonTextBox The RibbonTextBox class is a control that can be used to display or edit unformatted text.
TXTextControl.Windows.Forms.Ribbon.RibbonToggleButton The RibbonToggleButton class is a checkable button control which can be added to a RibbonGroup or to a RibbonMenuButton where it is stored as an item of the drop-down menu.
TXTextControl.Windows.Forms.Ribbon.RibbonToolTip The RibbonToolTip class represents a small rectangular pop-up window that displays the title and/or a brief description of a ribbon item's purpose when the user rests the pointer on the control.
TXTextControl.Windows.Forms.Ribbon.RibbonViewTab The RibbonViewTab class represents a Windows Forms ribbon tab for customizing the view settings.

Properties

Property Description
TXTextControl.ButtonBar.ReadOnly Gets or sets a value determining the button bar's read only mode.
TXTextControl.DocumentServer.MailMerge.DataRowMergedEventArgs.DataRow Gets the current data row's content.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.DataRow Gets the data row which is used to supply the current field with merge content.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.MergeBlockName If the merge field is part of a merge block, this property returns the name of the block.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.NestingDepth If the merge field is part of a merge block, this property returns the one-based nesting depth of the block.
TXTextControl.DocumentServer.MailMerge.FieldMergedEventArgs.TableCell If the merge field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.MergeBlockName If the image field is part of a merge block, this property returns the name of the block.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.NestingDepth If the image field is part of a merge block, this property returns the one-based nesting depth of the block.
TXTextControl.DocumentServer.MailMerge.ImageFieldMergedEventArgs.TableCell If the image field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.DataRow Gets the data row which is used to supply the current image with merge content.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.MergeBlockName If the image is part of a merge block, this property returns the name of the block.
TXTextControl.DocumentServer.MailMerge.ImageMergedEventArgs.NestingDepth If the image is part of a merge block, this property returns the one-based nesting depth of the block.
TXTextControl.DocumentServer.MailMerge.MergeBlockNamePrefix A static property returning the internal merge block name prefix “txmb_”.
TXTextControl.FormattingStyle.BaseStyle Gets the FormattingStyle which is the base style of this style.
TXTextControl.InputFormat.BottomAligned Gets or sets a value specifying whether text is bottom aligned at the current input position.
TXTextControl.InputFormat.FrameFillColor Gets or sets the color used to display the frame fill color at the current input position.
TXTextControl.InputFormat.FrameLineColor Gets or sets the color used to display the color of frame lines at the current text input position.
TXTextControl.InputFormat.FrameLineWidth Gets or sets the line width, in twips, of the paragraph's or table's frame at the current input position.
TXTextControl.InputFormat.TopAligned Gets or sets a value specifying whether text is top aligned at the current input position.
TXTextControl.InputFormat.VerticallyCentered Gets or sets a value specifying whether text is vertically centered at the current text input position.
TXTextControl.LoadSettings.DocumentAccessPermissions Specifies how a document can be accessed after it has been loaded.
TXTextControl.LoadSettings.LoadDocumentBackColor Specifies whether or not the document background color is loaded.
TXTextControl.LoadSettings.MasterPassword Specifies the password when the document is restricted with access permissions.
TXTextControl.LoadSettings.ReportingMergeBlockFormat Specifies how reporting merge blocks are handled when a document is loaded.
TXTextControl.LoadSettings.UserDefinedDocumentProperties Gets a dictionary with all user-defined document properties contained in the loaded document.
TXTextControl.LoadSettings.UserPassword Specifies the password for the user to open a password protected document.
TXTextControl.ParagraphFormat.BackColor Gets or sets the background color of a paragraph.
TXTextControl.ParagraphFormat.FrameLineColor Gets or sets the color used for the frame lines of a paragraph.
TXTextControl.RulerBar.ReadOnly Gets or sets a value determining the ruler bar's read only mode.
TXTextControl.SaveSettings.ReportingMergeBlockFormat Specifies how reporting merge blocks are handled when a document is saved.
TXTextControl.SaveSettings.SaveDocumentBackColor Specifies whether or not the document background color is saved.
TXTextControl.SaveSettings.UserDefinedDocumentProperties Sets a dictionary with all user-defined document properties which will be saved in the document.
TXTextControl.TextControl.Ribbon Specifies the ribbon control to be used with a TextControl.

Methods

Method Description
TXTextControl.DocumentServer.MailMerge.MergeJsonData Merges data given as a JSON string into a document template.
TXTextControl.HeaderFooter.GetTextFields Returns a collection containing text fields of the specified types.
TXTextControl.IFormattedText.GetTextFields Returns a collection containing text fields of the specified types.
TXTextControl.MaintText.GetTextFields Returns a collection containing text fields of the specified types.
TXTextControl.PageNumberFieldCollection.GetItem Gets a particular page number field from the collection.
TXTextControl.Selection.RemoveInlineStyles Removes all character based styles of the selected text so that all attributes are reset to the attributes of the paragraph style.
TXTextControl.ServerTextControl.GetSupportedPaperSizes Gets an array of PaperSize structures specifying the names and the size of all currently supported paper sizes.
TXTextControl.ServerTextControl.GetTextFields Returns a collection containing text fields of the specified types.
TXTextControl.ServerTextControl.OnDocumentLoaded Raises the DocumentLoaded event.
TXTextControl.TextControl.FrameFillColorDialog Invokes the built-in dialog box for choosing a color for the background of a paragraph or a table cell.
TXTextControl.TextControl.FrameLineColorDialog Invokes the built-in dialog box for choosing a color for the frame of a paragraph or a table.
TXTextControl.TextControl.GetSupportedPaperSizes Gets an array of PaperSize structures specifying the names and the size of all currently supported paper sizes.
TXTextControl.TextControl.GetTextFields Returns a collection containing text fields of the specified types.
TXTextControl.TextControl.OnDocumentLoaded Raises the DocumentLoaded event.
TXTextControl.TextControl.OnFrameClicked Raises the FrameClicked event.
TXTextControl.TextControl.OnFrameDeselected Raises the FrameDeselected event.
TXTextControl.TextControl.OnFrameDoubleClicked Raises the FrameDoubleClicked event.
TXTextControl.TextControl.OnFrameLayoutChanged Raises the FrameLayoutChanged event.
TXTextControl.TextControl.OnFrameMoved Raises the FrameMoved event.
TXTextControl.TextControl.OnFrameRightClicked Raises the FrameRightClicked event.
TXTextControl.TextControl.OnFrameSelected Raises the FrameSelected event.
TXTextControl.TextControl.OnFrameSized Raises the FrameSized event.
TXTextControl.TextControl.OnTextFrameAppearanceChanged Raises the TextFrameAppearanceChanged event.
TXTextControl.TextControl.PageColorDialog Invokes the built-in dialog box for setting the page color.
TXTextControl.TextControl.Zoom Zooms the contents of the TextControl.
TXTextControl.TextFrame.GetTextFields Returns a collection containing text fields of the specified types.

Events

Event Description
TXTextControl.ServerTextControl.DocumentLoaded Occurs when a new document has been loaded.
TXTextControl.TextControl.DocumentLoaded Occurs when a new document has been loaded.
TXTextControl.TextControl.FrameClicked Occurs when a frame (image, text frame, chart, barcode or drawing) has been clicked on.
TXTextControl.TextControl.FrameDeselected Occurs when a frame (image, text frame, chart, barcode or drawing) has been deselected.
TXTextControl.TextControl.FrameDoubleClicked Occurs when a frame (image, text frame, chart, barcode or drawing) has been doubleclicked on.
TXTextControl.TextControl.FrameLayoutChanged Occurs when the layout of a frame (image, text frame, chart, barcode or drawing) has been changed.
TXTextControl.TextControl.FrameMoved Occurs when a frame (image, text frame, chart, barcode or drawing) has been moved.
TXTextControl.TextControl.FrameRightClicked Occurs when a frame (image, text frame, chart, barcode or drawing) has been clicked on with the right mouse button.
TXTextControl.TextControl.FrameSelected Occurs when a frame (image, text frame, chart, barcode or drawing) has been selected.
TXTextControl.TextControl.FrameSized Occurs when a frame (image, text frame, chart, barcode or drawing) has been sized.
TXTextControl.TextControl.TextFrameAppearanceChanged Occurs when the appearance of a text frame (background color, transparency, border, inner margins) has been changed.