New Classes, Properties, Methods and Events

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

Classes

Class Description
TXTextControl.CommentCollection Contains all comments in the main text or another part of a document.
TXTextControl.CommentedText A CommentedText object represents a commented piece of text.
TXTextControl.CommentEventArgs The CommentEventArgs class provides data for the CommentCreated, CommentDeleted, CommentedTextEntered, CommentedTextLeft, CommentChanged and CommentStateChanged events.
TXTextControl.CommentsDialog The CommentsDialog class implements a dialog box that shows all comments of the document.
TXTextControl.DocumentServer.MailMerge.FormFieldMergedEventArgs The FormFieldMergedEventArgs class provides data for the FormFieldMerged event.
TXTextControl.Selection The Selection class describes and handles the attributes of a text selection.
TXTextControl.TrackedChangesDialog The TrackedChangesDialog class implements a dialog box that shows all tracked changes of the document.

Properties

Property Description
TXTextControl.CommentCollection.Count Gets the number of elements contained in the collection.
TXTextControl.CommentCollection.IsSynchronized Returns true if the collection is designed to be thread safe, otherwise, it returns false.
TXTextControl.CommentCollection.Item Gets the comment with the specified number from the collection.
TXTextControl.CommentCollection.SyncRoot Gets an object that can be used to synchronize access to the collection.
TXTextControl.CommentedText.Active Gets or sets a value specifying whether the comment is currently active or not.
TXTextControl.CommentedText.Comment Gets or sets a string which is the comment.
TXTextControl.CommentedText.CreationTime Gets the date and time when the comment has been inserted.
TXTextControl.CommentedText.DefaultHighlightColor Gets the default highlight color for the commented text.
TXTextControl.CommentedText.HighlightColor Gets or sets the highlight color for the commented text.
TXTextControl.CommentedText.HighlightMode Gets or sets a value indicating whether the commented text is highlighted.
TXTextControl.CommentedText.ID Gets or sets a user-defined identifier.
TXTextControl.CommentedText.Length Gets the number of commented characters.
TXTextControl.CommentedText.Number Gets the comment's number.
TXTextControl.CommentedText.RepliedComment Gets the comment for which this comment is a reply.
TXTextControl.CommentedText.Replies Gets all replies of this comment or null if there are no replies.
TXTextControl.CommentedText.Start Gets the index (one-based) of the first commented character.
TXTextControl.CommentedText.Text Gets the commented text.
TXTextControl.CommentedText.UserName Gets the name of the user who has commented the document.
TXTextControl.CommentEventArgs.CommentedText Gets an object that represents the commented text.
TXTextControl.DocumentServer.DataSources.MergeBlockSettings.AddResult Returns whether the new block has successfully been inserted by DataSourceManager.InsertMergeBlock.
TXTextControl.DocumentServer.MailMerge.FormFieldMergedEventArgs.DataRow Gets the data row which is used to supply the current field with merge content.
TXTextControl.DocumentServer.MailMerge.FormFieldMergedEventArgs.FormField Gets the already merged FormField.
TXTextControl.DocumentServer.MailMerge.FormFieldMergedEventArgs.MergeBlockName If the form field is part of a merge block, this property returns the name of the block.
TXTextControl.DocumentServer.MailMerge.FormFieldMergedEventArgs.Merged Gets a boolean value that indicates whether the current field has been merged successfully or not.
TXTextControl.DocumentServer.MailMerge.FormFieldMergedEventArgs.NestingDepth If the form field is part of a merge block, this property returns the one-based nesting depth of the block.
TXTextControl.DocumentServer.MailMerge.FormFieldMergedEventArgs.TableCell If the form field is inside of a table, this property returns the containing table cell as a TXTextControl.TableCell instance or null otherwise.
TXTextControl.DocumentServer.MailMerge.FormFieldMergeType Specifies in which manner form fields are treated during the merge process.
TXTextControl.DocumentServer.Windows.Forms.InsertMergeBlockDialog.AddResult Returns whether the new block has successfully been inserted.
TXTextControl.FormattingStyle.AutoBaseline Gets or sets values specifying automatic sub- or superscripted text.
TXTextControl.FormattingStyle.Capitals Gets or sets values specifying wheather lowercase letters are displayed with capital letters.
TXTextControl.FormattingStyle.CharacterScaling Gets or sets the style's character scaling, in percent of the average character width.
TXTextControl.FormattingStyle.CharacterSpacing Gets or sets the style's character spacing value, in twips.
TXTextControl.FormattingStyle.Culture Gets or sets the style's culture.
TXTextControl.HeaderFooter.Comments Gets a collection of all comments in the header or footer.
TXTextControl.IFormattedText.Comments Gets a collection of all comments.
TXTextControl.MainText.Comments Gets a collection of all comments in the main text of the document.
TXTextControl.Selection.AutoBaseline Gets or sets values specifying wheather the selected text is automatically sub- or superscripted.
TXTextControl.Selection.Baseline Gets or sets the baseline alignment, in twips, of the selected text.
TXTextControl.Selection.Bold Gets or sets the bold attribute of the selected text.
TXTextControl.Selection.Capitals Gets or sets values specifying wheather the lowercase letters of the selected text are displayed with capital letters.
TXTextControl.Selection.CharacterScaling Gets or sets a character scaling, in percent of the average character width, of the selected text.
TXTextControl.Selection.CharacterSpacing Gets or sets a character spacing value, in twips, of the selected text.
TXTextControl.Selection.FontName Gets or sets the font of the selected text.
TXTextControl.Selection.FontSize Gets or sets the font's size, in twips, of the selected text.
TXTextControl.Selection.ForeColor Returns or sets the color used to display the selected text.
TXTextControl.Selection.Italic Gets or sets the italic attribute of the selected text.
TXTextControl.Selection.Length Returns or sets the number of characters selected.
TXTextControl.Selection.ListFormat Gets or sets a bulleted or numbered list and/or its formatting attributes for the selected text.
TXTextControl.Selection.ParagraphFormat Gets or sets the formatting attributes of the selected paragraphs.
TXTextControl.Selection.Start Gets or sets the starting point of selected text.
TXTextControl.Selection.Strikeout Gets or sets the strikeout attribute of the selected text.
TXTextControl.Selection.Text Gets or sets a string containing the currently selected text.
TXTextControl.Selection.TextBackColor Gets or sets the background color for selected text.
TXTextControl.Selection.Underline Gets or sets underlining styles for the selected text.
TXTextControl.ServerTextControl.Comments Gets a collection of all comments.
TXTextControl.TextControl.CommentHighlightMode Gets or sets a value indicating whether all the commented texts in the document are highlighted.
TXTextControl.TextControl.Comments Gets a collection of all comments contained in the text part with the input focus.
TXTextControl.TextControl.EditableRegionHighlightMode Gets or sets a value indicating whether all the editable regions in the document are highlighted.
TXTextControl.TextFrame.BorderColor Gets or sets the color of a text frame's border line.
TXTextControl.TextFrame.BorderStyle Gets or sets the style of a text frame's border line.
TXTextControl.TextFrame.Comments Gets a collection of all comments in the text frame.
TXTextControl.Windows.Forms.Ribbon.RibbonProofingTab.CommentsHorizontalSidebar Gets or sets the horizontal sidebar that is connected to the RibbonProofingTab's TXITEM_Comments button.
TXTextControl.Windows.Forms.Ribbon.RibbonProofingTab.CommentsSidebar Gets or sets the vertical sidebar that is connected to the RibbonProofingTab's TXITEM_Comments button.

Methods

Method Description
TXTextControl.CommentCollection.Add Adds a new comment to the document.
TXTextControl.CommentCollection.CopyTo Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.CommentCollection.GetEnumerator Returns an enumerator that can be used to iterate through the collection.
TXTextControl.CommentCollection.GetItem Gets a particular item from the collection.
TXTextControl.CommentCollection.Remove Removes a CommentedText from the collection.
TXTextControl.CommentedText.EditComment Opens a comment input control to edit the comment's text.
TXTextControl.CommentedText.ReplyToComment Opens a comment input control to reply to this comment.
TXTextControl.CommentedText.Save Saves the commented text with the specified format.
TXTextControl.CommentedText.ScrollTo Sets the current input position to the first position of the commented text and scrolls it into the visible part of the document.
TXTextControl.CommentedText.Select Selects the commented part of the document.
TXTextControl.CommentsDialog.FindItem Finds a control that has the provided identifier name.
TXTextControl.Selection.ChangeCapitalization Changes the capitalization of all selected characters depending on the settings parameter.
TXTextControl.Selection.IsCommonValueSelected Informs about whether a certain attribute has the same value for the complete selection.
TXTextControl.Selection.Load Exchanges the currently selected text with text in a certain format.
TXTextControl.Selection.Save Saves the selected text of a document with the specified format.
TXTextControl.ServerTextControl.OnCommentCreated Raises the CommentCreated event.
TXTextControl.ServerTextControl.OnCommentDeleted Raises the CommentDeleted event.
TXTextControl.TextControl.OnCommentChanged Raises the CommentChanged event.
TXTextControl.TextControl.OnCommentCreated Raises the CommentCreated event.
TXTextControl.TextControl.OnCommentDeleted Raises the CommentDeleted event.
TXTextControl.TextControl.OnCommentedTextEntered Raises the CommentedTextEntered event.
TXTextControl.TextControl.OnCommentedTextLeft Raises the CommentedTextLeft event.
TXTextControl.TextControl.OnCommentStateChanged Raises the CommentStateChanged event.
TXTextControl.TrackedChangesDialog.FindItem Finds a control that has the provided identifier name.

Events

Event Description
TXTextControl.DocumentServer.MailMerge.FormFieldMerged Occurs when a form field has been merged.
TXTextControl.ServerTextControl.CommentCreated Occurs when a piece of text has been commented.
TXTextControl.ServerTextControl.CommentDeleted Occurs when a comment has been removed from the document.
TXTextControl.TextControl.CommentChanged Occurs when the text of a comment has been altered.
TXTextControl.TextControl.CommentCreated Occurs when a piece of text has been commented.
TXTextControl.TextControl.CommentDeleted Occurs when a comment has been removed from the document.
TXTextControl.TextControl.CommentedTextEntered Occurs when the current input position has been moved to a position that belongs to a commented piece of text.
TXTextControl.TextControl.CommentedTextLeft Occurs when the current input position has left a commented piece of text.
TXTextControl.TextControl.CommentStateChanged Occurs when the state of a comment alters from active to inactive or vice versa.