New Classes, Properties, Methods and Events

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

Classes

Class Description
TXTextControl.DocumentPermissions The DocumentPermissions class provides settings determining how the document can be edited, when the EditMode is changed from Edit to ReadAndSelect.
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.EditableRegion An EditableRegion object represents an editable region in a TX Text Control document.
TXTextControl.EditableRegionCollection Contains all editable regions in the main text or another part of a document.
TXTextControl.EditableRegionEventArgs The EditableRegionEventArgs class provides data for the EditableRegionCreated, EditableRegionDeleted, EditableRegionEntered and EditableRegionLeft events.
TXTextControl.MiniToolbar The MiniToolbar class is the base class of the built-in mini toolbars TextMiniToolbar and ObjectMiniToolbar of a Windows Forms TextControl.
TXTextControl.MiniToolbarInitializedEventArgs The MiniToolbarInitializedEventArgs class provides data for the TextControl.TextMiniToolbarInitialized or TextControl.ObjectMiniToolbarInitialized event of a Windows Forms TextControl just after the pre-defined TextMiniToolbar or ObjectMiniToolbar was created.
TXTextControl.MiniToolbarOpeningEventArgs The MiniToolbarOpeningEventArgs class provides data for the TextControl.MiniToolbarOpening event of a Windows Forms TextControl.
TXTextControl.ObjectMiniToolbar The ObjectMiniToolbar class is a mini toolbar that appears when the ShowMiniToolbar property is set to MiniToolbarButton.RightButton or MiniToolbarButton.LeftButton | MiniToolbarButton.RightButton, the right mouse button is released and the current context is a selected text frame, drawing frame or barcode frame (ContextMenuLocation.SelectedFrame).
TXTextControl.TextMiniToolbar The TextMiniToolbar class is a mini toolbar that appears when ShowMiniToolbar property is set to MiniToolbarButton.LeftButton, MiniToolbarButton.RightButton or MiniToolbarButton.LeftButton | MiniToolbarButton.RightButton, the left or right mouse button is released and the current context is selected text (ContextMenuLocation.TextSelection), text at the input position (ContextMenuLocation.TextInputPosition) or an input position inside a table (ContextMenuLocation.Table).
TXTextControl.ThesaurusDialog The ThesaurusDialog class implements a Windows Forms dialog box that shows synonyms for selected text or a word at the current input position which will be selected on opening the dialog.
TXTextControl.Windows.Forms.Ribbon.RibbonChartLayoutTab The RibbonChartLayoutTab class represents a Windows Forms ribbon tab for editing objects of type ChartFrame.
TXTextControl.Windows.Forms.Ribbon.RibbonPermissionsTab The RibbonPermissionsTab class represents a Windows Forms ribbon tab for determining how the document can be edited, when it is enforced to be protected.

Properties

Property Description
TXTextControl.DocumentPermissions.AllowCopy Specifies whether document content can be copied to the clipboard.
TXTextControl.DocumentPermissions.AllowFormatting Gets or sets a value specifying whether the document can be formatted.
TXTextControl.DocumentPermissions.AllowFormattingStyles Gets or sets a value specifying whether formatting styles can be used to format the document.
TXTextControl.DocumentPermissions.AllowPrinting Gets or sets a value specifying whether the document can be printed.
TXTextControl.DocumentPermissions.ReadOnly Gets or sets a value specifying whether the document is read only.
TXTextControl.EditableRegion.DefaultHighlightColor Gets the default highlight color of an editable region.
TXTextControl.EditableRegion.HighlightColor Gets or sets the highlight color for the editable region.
TXTextControl.EditableRegion.HighlightMode Gets or sets a value indicating when the editable region is highlighted.
TXTextControl.EditableRegion.ID Gets or sets the editable region's identifier.
TXTextControl.EditableRegion.Length Gets the number of characters which belong to the editable region.
TXTextControl.EditableRegion.Number Gets the editable region's number.
TXTextControl.EditableRegion.Start Gets the index (one-based) of the first character which belongs to the editable region.
TXTextControl.EditableRegion.Text Gets the editable region's text.
TXTextControl.EditableRegion.UserName Gets or sets the name of the user who can edit the region.
TXTextControl.EditableRegionCollection.Count Gets the number of elements contained in the collection.
TXTextControl.EditableRegionCollection.IsSynchronized Returns true if the collection is designed to be thread safe, otherwise, it returns false.
TXTextControl.EditableRegionCollection.Item Gets the editable region with the specified number from the collection.
TXTextControl.EditableRegionCollection.SyncRoot Gets an object that can be used to synchronize access to the collection.
TXTextControl.EditableRegionEventArgs.EditableRegion Gets an object that represents the editable region which causes the event.
TXTextControl.FrameBase.Bounds Gets the frame's bounding rectangle relative to the upper left corner of the document.
TXTextControl.HeaderFooter.EditableRegions Gets a collection of all editable regions in the header or footer.
TXTextControl.IFormattedText.EditableRegions Gets a collection of all editable regions.
TXTextControl.MiniToolbar.RibbonGroups Gets a collection of all ribbon groups in a MiniToolbar.
TXTextControl.MiniToolbarInitializedEventArgs.MiniToolbar Considering which event (TextControl.TextMiniToolbarInitialized or TextControl.ObjectMiniToolbarInitialized) is raised the property provides an object of type TextMiniToolbar or ObjectMiniToolbar that can be altered, extended or completely replaced.
TXTextControl.MiniToolbarOpeningEventArgs.Location Gets the location, in pixels, where the mini toolbar is displayed.
TXTextControl.MiniToolbarOpeningEventArgs.MiniToolbar Gets or sets the mini toolbar, which will be shown.
TXTextControl.MiniToolbarOpeningEventArgs.MiniToolbarContext Gets the context in the document for which a mini toolbar will be opened.
TXTextControl.ServerTextControl.EditableRegions Gets a collection of all editable regions contained in the document.
TXTextControl.TextControl.CanCharacterFormat Informs whether the currently selected text can be formatted with character formatting attributes.
TXTextControl.TextControl.CanDocumentFormat Informs whether the document can be formatted with page and section formatting attributes.
TXTextControl.TextControl.CanEdit Informs whether the document's text and/or formatting attributes can be changed.
TXTextControl.TextControl.CanParagraphFormat Informs whether the currently selected text can be formatted with paragraph formatting attributes.
TXTextControl.TextControl.CanPrint Informs whether the document can be printed.
TXTextControl.TextControl.CanStyleFormat Informs whether the document can be formatted with formatting styles.
TXTextControl.TextControl.CanTableFormat Informs whether the currently selected text can be formatted with table formatting attributes.
TXTextControl.TextControl.DocumentPermissions Gets a DocumentPermissions object which provides properties determining how a document can be edited and formatted when the EditMode property is set to EditMode.ReadAndSelect.
TXTextControl.TextControl.EditableRegions Gets a collection of all editable regions contained in the document.
TXTextControl.TextControl.SelectObjects Gets or sets a value controlling the selection of objects which are inserted behind the text.
TXTextControl.TextControl.ShowMiniToolbar Gets or sets a value indicating whether a mini toolbar is shown.
TXTextControl.TextControl.UserNames Gets or sets a list of names specifying users who have access to editable regions.
TXTextControl.TextFrame.EditableRegions Gets a collection of all editable regions in the text frame.
TXTextControl.Windows.Forms.Ribbon.RibbonListView.MaxColumnCount Gets or sets a value specifying the maximum number of columns in this RibbonListView.
TXTextControl.Windows.Forms.Ribbon.RibbonListView.MinRowCount Gets or sets the minimum number of rows in this RibbonListView.
TXTextControl.Windows.Forms.Ribbon.RibbonPermissionsTab.AllowAddingUserNames Gets or sets a value indicating whether the user can add user names by the RibbonPermissionsTab's Add Users dialog that are not represented by the RegisteredUserNames property.
TXTextControl.Windows.Forms.Ribbon.RibbonPermissionsTab.RegisteredUserNames Gets or sets an array of strings that represents those registered user names that can be added by the RibbonPermissionsTab's Add Users dialog.

Methods

Method Description
TXTextControl.EditableRegion.Save Saves the editable region's text with the specified format.
TXTextControl.EditableRegion.ScrollTo Sets the current input position to the beginning of an editable region and scrolls it into the visible part of the document.
TXTextControl.EditableRegionCollection.Add Adds a new editable region to the document.
TXTextControl.EditableRegionCollection.CopyTo Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.EditableRegionCollection.GetEnumerator Returns an enumerator that can be used to iterate through the collection.
TXTextControl.EditableRegionCollection.GetItem Gets the editable region with the specified id.
TXTextControl.EditableRegionCollection.GetItems Gets all editable regions at the current text input position.
TXTextControl.EditableRegionCollection.Remove Removes an editable region from the collection.
TXTextControl.ObjectMiniToolbar.FindItem Finds a control that has the provided ObjectMiniToolbar.RibbonItem identifier.
TXTextControl.ServerTextControl.OnContentsReset Raises the ContentsReset event.
TXTextControl.ServerTextControl.OnEditableRegionCreated Raises the EditableRegionCreated event.
TXTextControl.ServerTextControl.OnEditableRegionDeleted Raises the EditableRegionDeleted event.
TXTextControl.ServerTextControl.OnSubTextPartCreated Raises the SubTextPartCreated event.
TXTextControl.ServerTextControl.OnSubTextPartDeleted Raises the SubTextPartDeleted event.
TXTextControl.ServerTextControl.SelectWord Selects the word at the current text input position.
TXTextControl.TextControl.ClientToDocument Computes client coordinates into document coordinates which are in twips relative to the top-left corner of the whole document.
TXTextControl.TextControl.DocumentToClient Computes coordinates in twips relative to the top-left corner of the document into client coordinates.
TXTextControl.TextControl.OnContentsReset Raises the ContentsReset event.
TXTextControl.TextControl.OnEditableRegionCreated Raises the EditableRegionCreated event.
TXTextControl.TextControl.OnEditableRegionDeleted Raises the EditableRegionDeleted event.
TXTextControl.TextControl.OnEditableRegionEntered Raises the EditableRegionEntered event.
TXTextControl.TextControl.OnEditableRegionLeft Raises the EditableRegionLeft event.
TXTextControl.TextControl.OnMiniToolbarOpening Raises the MiniToolbarOpening event.
TXTextControl.TextControl.OnObjectMiniToolbarInitialized Raises the ObjectMiniToolbarInitialized event.
TXTextControl.TextControl.OnSubTextPartCreated Raises the SubTextPartCreated event.
TXTextControl.TextControl.OnSubTextPartDeleted Raises the SubTextPartDeleted event.
TXTextControl.TextControl.OnTextMiniToolbarInitialized Raises the TextMiniToolbarInitialized event.
TXTextControl.TextControl.SelectWord Selects the word at the current text input position.
TXTextControl.TextMiniToolbar.FindItem Finds a control that has the provided TextMiniToolbar.RibbonItem identifier.
TXTextControl.ThesaurusDialog.FindItem Finds a control that has the provided identifier name.
TXTextControl.Windows.Forms.Ribbon.RibbonChartLayoutTab.FindItem Finds a control that has the provided RibbonChartLayoutTab.RibbonItem identifier.
TXTextControl.Windows.Forms.Ribbon.RibbonPermissionsTab.FindItem Finds a control that has the provided RibbonPermissionsTab.RibbonItem identifier.

Events

Event Description
TXTextControl.ServerTextControl.ContentsReset Occurs when all text contents have been deleted and all attributes have been reset to the state after initialization.
TXTextControl.ServerTextControl.EditableRegionCreated Occurs when an editable region has been created.
TXTextControl.ServerTextControl.EditableRegionDeleted Occurs when an editable region has been deleted.
TXTextControl.ServerTextControl.SubTextPartCreated Occurs when a subtextpart has been created.
TXTextControl.ServerTextControl.SubTextPartDeleted Occurs when a subtextpart has been deleted.
TXTextControl.TextControl.ContentsReset Occurs when all text contents have been deleted and all attributes have been reset to the state after initialization.
TXTextControl.TextControl.EditableRegionCreated Occurs when an editable region has been created.
TXTextControl.TextControl.EditableRegionDeleted Occurs when an editable region has been deleted.
TXTextControl.TextControl.EditableRegionEntered Occurs when the current input position has been moved to a position that belongs to an editable region.
TXTextControl.TextControl.EditableRegionLeft Occurs when the current input position has left an editable region.
TXTextControl.TextControl.MiniToolbarOpening Occurs to handle displaying context sensitive mini toolbars.
TXTextControl.TextControl.ObjectMiniToolbarInitialized Occurs immediately after the built-in ObjectMiniToolbar was initialized.
TXTextControl.TextControl.SubTextPartCreated Occurs when a subtextpart has been created.
TXTextControl.TextControl.SubTextPartDeleted Occurs when a subtextpart has been deleted.
TXTextControl.TextControl.TextMiniToolbarInitialized Occurs immediately after the built-in TextMiniToolbar was initialized.
TXTextControl.Windows.Forms.Ribbon.RibbonListView.ItemMouseDown Occurs when the mouse pointer is over a RibbonListViewItem and the mouse button is pressed.
TXTextControl.Windows.Forms.Ribbon.RibbonListView.ItemMouseUp Occurs when the mouse pointer is over a RibbonListViewItem and the mouse button is released.