TXTextControl.ServerTextControl Class

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.

Introduced: 12.0.

Syntax

[C#]
public class ServerTextControl : Component, IFormattedText
[Visual Basic]
Public Class ServerTextControl
  Inherits Component
  Implements IFormattedText

Constructors

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

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.
DocumentLinks Gets a collection of all links that point to targets in the same document.
DocumentTargets Gets a collection of all targets in the document.
Drawings Gets a collection of all drawings in a document.
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.
ForeColor Gets or sets the foreground color of the control.
FormattingPrinter Gets or sets the name of a printer the text dimensions and capabilities of which are used to format the document.
Frames Gets a collection of all images, textframes, charts and barcodes in a document.
GetPages Gets a collection of all pages in the 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.
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.
Pages Gets the number of pages contained in 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.
ParagraphFormat Gets or sets the paragraph formatting attributes of the text displayed by the control.
Paragraphs Gets a collection of all paragraphs contained in the main text of the document.
ParagraphStyles Gets a collection of all paragraph styles the current document contains.
Sections Gets a collection of all sections in the document.
Selection Gets or sets the current selection 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.
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.

Methods

Method Description
Append Overloaded. 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 Overloaded. Finds a text string in the main text of 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 Overloaded. Loads text in a certain format.
OnAdaptFont Raises the AdaptFont event.
OnBarcodeCreated Raises the BarcodeCreated event.
OnBarcodeDeleted Raises the BarcodeDeleted event.
OnDocumentLoaded Raises the DocumentLoaded event.
OnDrawingCreated Raises the DrawingCreated event.
OnDrawingDeleted Raises the DrawingDeleted event.
OnHyphenateWord Raises the HyphenateWord event.
OnImageCreated Raises the ImageCreated event.
OnImageDeleted Raises the ImageDeleted event.
OnSpellCheckText Raises the SpellCheckText event.
OnTableCreated Raises the TableCreated event.
OnTableDeleted Raises the TableDeleted event.
OnTextFrameCreated Raises the TextFrameCreated event.
OnTextFrameDeleted Raises the TextFrameDeleted event.
OnXmlInvalid Raises the XmlInvalid event.
OnXmlNotWellFormed Raises the XmlNotWellFormed event.
Print Overloaded. 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 Overloaded. Saves the complete contents of a document with the specified format.
Select Selects text within the control.
SelectAll Selects all text in the control.

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.
DocumentLoaded Occurs when a new document has been loaded.
DrawingCreated Occurs when a new drawing has been created.
DrawingDeleted Occurs when a drawing 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.
SpellCheckText Occurs, if the document's text has been altered and the spelling of the new text must be checked.
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.
TextFrameCreated Occurs when a new text frame has been created.
TextFrameDeleted Occurs when a text frame 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.