New Classes, Properties, Methods and Events

In TX Text Control 32.0 for ASP.NET the following new classes, properties, methods and events have been added:

Properties

Property Description
Javascript: ComponentSettings.containerID The ID of the editor container DIV element.
Javascript: ComponentSettings.domContentLoaded Optional.
Javascript: ComponentSettings.editorSettings Optional.
Javascript: ComponentSettings.replaceContainer Optional.
Javascript: ComponentSettings.webSocketURL The WebSocket URL.
Javascript: DictionaryInfo.fileName The dictionary file name.
Javascript: DictionaryInfo.isLoaded Indicates whether the dictionary is currently loaded.
Javascript: DocumentEditorSettings.connectionID Optional.
Javascript: DocumentEditorSettings.contextMenusEnabled Optional.
Javascript: DocumentEditorSettings.culture Optional.
Javascript: DocumentEditorSettings.customQueryParams Optional.
Javascript: DocumentEditorSettings.editMode Optional.
Javascript: DocumentEditorSettings.formattingPrinter Optional.
Javascript: DocumentEditorSettings.reconnectTimeout Optional.
Javascript: DocumentEditorSettings.uiCulture Optional.
Javascript: DocumentEditorSettings.userNames Optional.
Javascript: FootnoteCallbackData.added Indicates whether the footnote was added successfully.
Javascript: FootnoteCallbackData.footnote The added footnote.
Javascript: FootnoteEventArgs.highlightColor The footnote's highlight color.
Javascript: FootnoteEventArgs.highlightMode The footnote's highlight mode (see TXTextControl.HighlightMode).
Javascript: FootnoteEventArgs.id The footnote's identifier.
Javascript: FootnoteEventArgs.name The footnote's name.
Javascript: FootnoteEventArgs.number The footnote's 1-based number in the text flow.
Javascript: FootnoteEventArgs.referenceMarkLength The footnote's reference mark length in characters.
Javascript: FootnoteEventArgs.referenceMarkStart The footnote's 1-based reference mark start position.
Javascript: RibbonTabLoadedEventArgs.elemTab The HTML element of the ribbon tab.
Javascript: RibbonTabLoadedEventArgs.tabName The name of the ribbon tab.
Javascript: TXTextControl.footnotes All footnotes contained in the main text of the document.
TXTextControl.Footnote.DefaultHighlightColor Gets the default highlight color for the reference mark and the footnote mark.
TXTextControl.Footnote.HighlightColor Gets or sets the highlight color for the reference mark and the footnote mark.
TXTextControl.Footnote.HighlightMode Gets or sets a value indicating whether the reference mark and the footnote mark is highlighted.
TXTextControl.Footnote.ID Gets or sets a user-defined identifier.
TXTextControl.Footnote.Name Gets or sets a name for the footnote.
TXTextControl.Footnote.Number Gets the footnote's number in the text.
TXTextControl.Footnote.ReferenceMarkLength Gets the number of characters the reference mark consists of.
TXTextControl.Footnote.ReferenceMarkStart Gets the index (one-based) of the first character of the footnote's reference mark.
TXTextControl.Footnote.Text Gets the footnote's text including the footnote mark in front of the text.
TXTextControl.FootnoteCollection.Count Gets the number of elements contained in the collection.
TXTextControl.FootnoteCollection.HighlightMode Gets or sets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.
TXTextControl.FootnoteCollection.Item Gets the footnote with the specified number from the collection.
TXTextControl.FootnoteCollection.NumberFormat Gets or sets the footnotes' number format.
TXTextControl.FootnoteCollection.StartNumber Gets or sets the number for the first footnote.
TXTextControl.FootnoteEventArgs.Footnote Gets an object that represents the footnote which causes the event.
TXTextControl.HeaderFooter.Distance Gets or sets the distance, in twips, of a header or footer to the top or bottom of the page.
TXTextControl.HeaderFooter.Images Gets a collection of all images the header or footer contains.
TXTextControl.HeaderFooter.PageNumberFields Gets a collection of page number fields in the header or footer.
TXTextControl.HeaderFooter.Selection Gets or sets the current selection in a header or footer.
TXTextControl.HeaderFooter.TextFields Gets a collection of all standard text fields in the header or footer.
TXTextControl.HeaderFooter.Type Gets the type of the header or footer.
TXTextControl.ServerTextControl.Footnotes Gets a collection of all footnotes contained in the main text of the document.

Methods

Method Description
Javascript: Footnote.edit Sets the current text input position in the footnote section at the end of the current footnote text, so that the text can be edited or formatted.
Javascript: Footnote.getHighlightColor Gets the highlight color for the reference mark and the footnote mark.
Javascript: Footnote.getHighlightMode Gets a value indicating whether the reference mark and the footnote mark is highlighted.
Javascript: Footnote.getID Gets a user-defined identifier.
Javascript: Footnote.getName Gets the footnote's name.
Javascript: Footnote.getNumber Gets the footnote's number in the text.
Javascript: Footnote.getReferenceMarkLength Gets the number of characters the reference mark consists of.
Javascript: Footnote.getReferenceMarkStart Gets the index (one-based) of the first character of the footnote's reference mark.
Javascript: Footnote.scrollTo Scrolls the beginning of the footnote mark into the visible part of the document using a default position depending on the previous position.
Javascript: Footnote.scrollToPosition Scrolls the beginning of the footnote mark into the visible part of the document using the specified position.
Javascript: Footnote.setHighlightColor Sets the highlight color for the reference mark and the footnote mark.
Javascript: Footnote.setHighlightMode Sets a value indicating whether the reference mark and the footnote mark is highlighted.
Javascript: Footnote.setID Sets a user-defined identifier.
Javascript: Footnote.setName Sets a name for the footnote.
Javascript: FootnoteCollection.add Adds a new footnote with the given text to the document at the current input position.
Javascript: FootnoteCollection.getDefaultFootnoteHighlightColor Gets the default highlight color for the reference mark and the footnote mark.
Javascript: FootnoteCollection.getHighlightMode Gets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.
Javascript: FootnoteCollection.getNumberFormat Gets the footnotes' number format.
Javascript: FootnoteCollection.getStartNumber Gets the number for the first footnote.
Javascript: FootnoteCollection.remove Removes a footnote from a Text Control document.
Javascript: FootnoteCollection.setHighlightMode Sets a value indicating whether all the footnote numbers, reference marks as well as footnote marks, in the document are highlighted.
Javascript: FootnoteCollection.setNumberFormat Sets the footnotes' number format.
Javascript: FootnoteCollection.setStartNumber Sets the number for the first footnote.
Javascript: FormattedText.getTextFieldsByType Returns an array of static text field information objects.
Javascript: SubTextPart.getChildren Returns an array of the children of this SubTextPart.
Javascript: SubTextPart.getTextFields Returns an array of static text field information objects.
Javascript: TXTextControl.getRenderMode Gets the component render mode.
Javascript: TXTextControl.init Initializes the document editor.
Javascript: TXTextControl.Proofing.getDictionaryList Retrieves a list of the names of all dictionary files on the server.
Javascript: TXTextControl.Proofing.loadDictionary Loads a dictionary.
Javascript: TXTextControl.Proofing.removeDictionary Removes a dictionary from the loaded dictionaries.
Javascript: TXTextControl.setRenderMode Sets the component render mode.
Javascript: TXTextControl.showHtmlDialog Shows one of the a built-in HTML dialog boxes.
TXTextControl.Footnote.Edit Sets the current text input position in the footnote section at the end of the current footnote text, so that the text can be edited or formatted.
TXTextControl.Footnote.Save Saves the footnote's text with the specified format including the footnote mark in front of the text.
TXTextControl.Footnote.ScrollTo Sets the current input position to the first position of the footnote mark and scrolls it into the visible part of the document.
TXTextControl.FootnoteCollection.Add Adds a new footnote to the document at the current text input position.
TXTextControl.FootnoteCollection.CopyTo Copies the elements of the collection to an array, starting at a particular index.
TXTextControl.FootnoteCollection.GetEnumerator Returns an enumerator that can be used to iterate through the collection.
TXTextControl.FootnoteCollection.GetItem Gets a particular footnote from the collection.
TXTextControl.FootnoteCollection.Remove Removes a footnote from a Text Control document.
TXTextControl.HeaderFooter.Activate Activates a header or a footer.
TXTextControl.HeaderFooter.AddUndoUnit Adds the current state of the header or footer to the undo stack.
TXTextControl.HeaderFooter.Deactivate Deactivates a header or a footer.
TXTextControl.Selection.RemoveFormatting Resets all character based formatting attributes of the selected text to its default values.
TXTextControl.ServerTextControl.OnFootnoteCreated Raises the FootnoteCreated event.
TXTextControl.ServerTextControl.OnFootnoteDeleted Raises the FootnoteDeleted event.
TXTextControl.ServerVisualization.TextViewGenerator.OnFootnoteReferenceMarkEntered Raises the FootnoteReferenceMarkEntered event.
TXTextControl.ServerVisualization.TextViewGenerator.OnFootnoteReferenceMarkLeft Raises the FootnoteReferenceMarkLeft event.
TXTextControl.ServerVisualization.TextViewGenerator.OnFootnoteSectionActivated Raises the FootnoteSectionActivated event.
TXTextControl.ServerVisualization.TextViewGenerator.OnFootnoteSectionDeactivated Raises the FootnoteSectionDeactivated event.

Classes

Class Description
TXTextControl.Footnote A Footnote object represents a footnote in a TextControl document.
TXTextControl.FootnoteCollection An instance of the FootnoteCollection class contains all footnotes in a Text Control document represented through objects of the type Footnote.
TXTextControl.FootnoteEventArgs The FootnoteEventArgs class provides data for the FootnoteCreated, FootnoteDeleted, FootnoteReferenceMarkEntered and FootnoteReferenceMarkLeft events.
TXTextControl.FootnoteSection The FootnoteSection class represents a footnote section at the bottom of a page.
TXTextControl.FootnoteText The FootnoteText class represents the text of all footnotes contained in a document.
TXTextControl.HeaderFooter An instance of the HeaderFooter class represents a header or footer in a Text Control document.

Events

Event Description
TXTextControl.ServerTextControl.FootnoteCreated Occurs when a footnote has been created.
TXTextControl.ServerTextControl.FootnoteDeleted Occurs when a footnote has been deleted.
TXTextControl.ServerVisualization.TextViewGenerator.FootnoteReferenceMarkEntered Occurs when the current input position has been moved to the position of a footnote reference mark.
TXTextControl.ServerVisualization.TextViewGenerator.FootnoteReferenceMarkLeft Occurs when the current input position has left the position of a footnote reference mark.
TXTextControl.ServerVisualization.TextViewGenerator.FootnoteSectionActivated Occurs when the footnote section of a document's page gets the current text input position from another part of the document.
TXTextControl.ServerVisualization.TextViewGenerator.FootnoteSectionDeactivated Occurs when the footnote section of a document's page has lost the current text input position.