TXTextControl.ServerTextControl Class - TX Text Control .NET for Windows Forms

The ServerTextControl class implements a component that provide high-level text processing features for server-based applications. It is inherited from the System.ComponentModel.Component class. The following describes only the properties, methods and events defined through the ServerTextControl class. For a list of properties, methods and events inherited from the System.ComponentModel.Component class see the .NET Framework reference. The ServerTextControl class implements the IFormattedText interface.

public class ServerTextControl : Component, IFormattedText

Public Class ServerTextControl
  Inherits Component
  Implements IFormattedText

Introduced: 12.0.

Constructors

Constructor	Description
ServerTextControl	Initializes a new instance of the ServerTextControl class.

Events

Event	Description
AdaptFont	Occurs for each font that must be adapted, because it is not supported.
BarcodeCreated	Occurs when a new barcode has been created.
BarcodeDeleted	Occurs when a barcode has been deleted.
ChartCreated	Occurs when a new chart has been created.
ChartDeleted	Occurs when a chart has been deleted.
CommentCreated	Occurs when a piece of text has been commented.
CommentDeleted	Occurs when a comment has been removed from the document.
ContentsReset	Occurs when all text contents have been deleted and all attributes have been reset to the state after initialization.
DocumentLoaded	Occurs when a new document has been loaded.
DocumentTargetCreated	Occurs when a document target has been created.
DocumentTargetDeleted	Occurs when a document target has been deleted.
DrawingCreated	Occurs when a new drawing has been created.
DrawingDeleted	Occurs when a drawing has been deleted.
EditableRegionCreated	Occurs when an editable region has been created.
EditableRegionDeleted	Occurs when an editable region has been deleted.
FootnoteCreated	Occurs when a footnote has been created.
FootnoteDeleted	Occurs when a footnote has been deleted.
HyphenateWord	Occurs, if a word does not fit on the line and must be hyphenated.
ImageCreated	Occurs when a new image has been created.
ImageDeleted	Occurs when an image has been deleted.
SignatureFieldCreated	Occurs when a new signature field has been created.
SignatureFieldDeleted	Occurs when a signature field has been deleted.
SpellCheckText	Occurs, if the document's text has been altered and the spelling of the new text must be checked.
SubTextPartCreated	Occurs when a subtextpart has been created.
SubTextPartDeleted	Occurs when a subtextpart has been deleted.
TableCreated	Occurs after a new table has been created when loading a document which contains a table without an identifier.
TableDeleted	Occurs after a table has been deleted.
TableOfContentsCreated	Occurs when a table of contents has been created.
TableOfContentsDeleted	Occurs when a table of contents has been deleted.
TextFieldCreated	Occurs when a text field has been created.
TextFieldDeleted	Occurs when a text field has been deleted.
TextFrameCreated	Occurs when a new text frame has been created.
TextFrameDeleted	Occurs when a text frame has been deleted.
TrackedChangeCreated	Occurs when a tracked change has been created.
TrackedChangeDeleted	Occurs when a tracked change has been deleted.
XmlInvalid	Occurs when a loaded or changed XML document cannot be validated with the document type definition (DTD) referenced in the document.
XmlNotWellFormed	Occurs when a loaded XML document is not well-formed.

Methods

Method	Description
Append	Loads text in a certain format from a file, a byte array or a string and appends it to the existing document.
Clear	Clears the selected text or the character right from the current input position.
Create	Initializes the resources of a newly instantiated object.
Find	Finds a text string in the main text of the document.
GetPages	Gets a collection of all pages in the document.
GetSupportedFonts	Gets an array of strings specifying the names of all currently supported fonts.
GetSupportedPaperSizes	Gets an array of PaperSize structures specifying the names and the size of all currently supported paper sizes.
GetTextFields	Returns a collection containing text fields of the specified types.
GetVersionInfo	Returns an object of the type VersionInfo, which provides information about the installed TX Text Control version.
GetXmlElements	Returns a collection of XML elements.
Load	Loads text in a certain format.
OnAdaptFont	Raises the AdaptFont event.
OnBarcodeCreated	Raises the BarcodeCreated event.
OnBarcodeDeleted	Raises the BarcodeDeleted event.
OnCommentCreated	Raises the CommentCreated event.
OnCommentDeleted	Raises the CommentDeleted event.
OnContentsReset	Raises the ContentsReset event.
OnDocumentLoaded	Raises the DocumentLoaded event.
OnDocumentTargetCreated	Raises the DocumentTargetCreated event.
OnDocumentTargetDeleted	Raises the DocumentTargetDeleted event.
OnDrawingCreated	Raises the DrawingCreated event.
OnDrawingDeleted	Raises the DrawingDeleted event.
OnEditableRegionCreated	Raises the EditableRegionCreated event.
OnEditableRegionDeleted	Raises the EditableRegionDeleted event.
OnFootnoteCreated	Raises the FootnoteCreated event.
OnFootnoteDeleted	Raises the FootnoteDeleted event.
OnHyphenateWord	Raises the HyphenateWord event.
OnImageCreated	Raises the ImageCreated event.
OnImageDeleted	Raises the ImageDeleted event.
OnSignatureFieldCreated	Raises the SignatureFieldCreated event.
OnSignatureFieldDeleted	Raises the SignatureFieldDeleted event.
OnSpellCheckText	Raises the SpellCheckText event.
OnSubTextPartCreated	Raises the SubTextPartCreated event.
OnSubTextPartDeleted	Raises the SubTextPartDeleted event.
OnTableCreated	Raises the TableCreated event.
OnTableDeleted	Raises the TableDeleted event.
OnTableOfContentsCreated	Raises the TableOfContentsCreated event.
OnTableOfContentsDeleted	Raises the TableOfContentsDeleted event.
OnTextFieldCreated	Raises the TextFieldCreated event.
OnTextFieldDeleted	Raises the TextFieldDeleted event.
OnTextFrameCreated	Raises the TextFrameCreated event.
OnTextFrameDeleted	Raises the TextFrameDeleted event.
OnTrackedChangeCreated	Raises the TrackedChangeCreated event.
OnTrackedChangeDeleted	Raises the TrackedChangeDeleted event.
OnXmlInvalid	Raises the XmlInvalid event.
OnXmlNotWellFormed	Raises the XmlNotWellFormed event.
Print	Prints a Text Control document or a part of a document.
ResetBackColor	Resets the BackColor property to its default value.
ResetContents	Deletes the entire contents of the control.
ResetFont	Resets the Font property to its default value.
ResetForeColor	Resets the ForeColor property to its default value.
ResetPageMargins	Resets the PageMargins property to its default value.
ResetPageSize	Resets the PageSize property to its default value.
ResetTextBackColor	Resets the TextBackColor property to its default value.
Save	Saves the complete contents of a document with the specified format.
Select	Selects text within the control.
SelectAll	Selects all text in the control.
SelectWord	Selects the word at the current text input position.

Properties

Property	Description
ApplicationFields	Gets a collection of all Microsoft Word or Heiler HighEdit fields that have been created or imported from a Microsoft Word or RTF document.
BackColor	Gets or sets the background color of the control.
Barcodes	Gets a collection of all barcodes in a document.
Baseline	Gets or sets the baseline alignment, in twips, of the control.
Charts	Gets a collection of all charts in a document.
Comments	Gets a collection of all comments.
DocumentLinks	Gets a collection of all links that point to targets in the same document.
DocumentSettings	Gets a DocumentSettings object providing properties which inform about general document settings, such as author and title, contained in the document the user is currently working on.
DocumentTargets	Gets a collection of all targets in the document.
Drawings	Gets a collection of all drawings in a document.
EditableRegions	Gets a collection of all editable regions contained in the document.
EntryAssembly	Sets main project assembly which licenses a ServerTextControl.
Font	Gets or sets the control's font.
FontSettings	Gets a FontSettings object which provides properties determining which fonts can be used in a document.
FontUnderlineStyle	Gets or sets underlining style for the text displayed by the control.
Footnotes	Gets a collection of all footnotes contained in the main text of the document.
ForeColor	Gets or sets the foreground color of the control.
FormFields	Gets a collection of all form fields contained in the document.
FormattingPrinter	Gets or sets the name of a printer the text dimensions and capabilities of which are used to format the document.
FormulaReferenceStyle	Gets or sets a value determining how references to table cells in formulas are specified.
Frames	Gets a collection of all images, textframes, charts and barcodes in a document.
HeadersAndFooters	Gets a collection of all headers and footers the current document contains.
HypertextLinks	Gets a collection of all hypertext links contained in the main text of the document.
Images	Gets a collection of all images contained in the main text of the document.
InlineStyles	Gets a collection of all inline styles the current document contains.
InputPosition	Gets or sets the current text input position.
IsCreated	Gets a value indicating whether the control is completely created.
IsFormulaCalculationEnabled	Gets or sets a value indicating whether formulas in tables are automatically calculated when the text of an input cell is changed.
IsHyphenationEnabled	Gets or sets a value indicating whether hyphenation is active or not.
IsLanguageDetectionEnabled	Gets or sets a value indicating whether language detection is active or not.
IsSpellCheckingEnabled	Gets or sets a value indicating whether spell checking is active or not.
Landscape	Gets or sets a value indicating whether the page orientation is landscape or portrait.
Lines	Gets a collection of all lines contained in the main text of the document.
ListFormat	Gets or sets the type and the formatting attributes of a bulleted or numbered list.
MisspelledWords	Gets a collection of all misspelled words in the main text of the document.
PageMargins	Gets or sets the margins for the pages of the current document.
PageSize	Specifies the width and height of the pages for the current document.
PageUnit	Gets or sets the measure used for page sizes and page margins.
Pages	Gets the number of pages contained in the current document.
ParagraphFormat	Gets or sets the paragraph formatting attributes of the text displayed by the control.
ParagraphStyles	Gets a collection of all paragraph styles the current document contains.
Paragraphs	Gets a collection of all paragraphs contained in the main text of the document.
Sections	Gets a collection of all sections in the document.
Selection	Gets or sets the current selection in the main text of the document.
SignatureFields	Gets a collection of all signature fields contained in the main text of the document.
SpellChecker	Specifies the spell checking component to be used with a ServerTextControl.
SubTextParts	Gets a collection of all subtextparts contained in the document.
Tables	Gets a collection of all tables contained in the document.
TablesOfContents	Gets a collection of all tables of contents in the document.
Text	Gets or sets the control's text.
TextBackColor	Gets or sets the background color for the text.
TextChars	Gets a collection of all characters contained in the main text of the document.
TextFields	Gets a collection of all standard text fields contained in the main text of the document.
TextFrames	Gets a collection of all text frames the current document contains.
TextParts	Gets a collection of all text parts the current document contains.
TrackedChanges	Gets a collection of all changes made in the active part of the document.

ServerTextControl Class

TXTextControl Namespace

Syntax

Constructors

Events

Methods

Properties

Further Reading

ServerTextControl Class

TXTextControl Namespace​

Syntax

Constructors

Events

Methods

Properties

Further Reading

TXTextControl Namespace