TX Text Control .NET for Windows Forms Documentation

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

ConstructorDescription
ServerTextControlInitializes a new instance of the ServerTextControl class.

Properties

PropertyDescription
ApplicationFieldsGets a collection of all Microsoft Word or Heiler HighEdit fields that have been created or imported from a Microsoft Word or RTF document.
BackColorGets or sets the background color of the control.
BaselineGets or sets the baseline alignment, in twips, of the control.
DocumentLinksGets a collection of all links that point to targets in the same document.
DocumentTargetsGets a collection of all targets in the document.
FontGets or sets the control's font.
FontSettingsGets a FontSettings object which provides properties determining which fonts can be used in a document.
FontUnderlineStyleGets or sets underlining style for the text displayed by the control.
ForeColorGets or sets the foreground color of the control.
FormattingPrinterGets or sets the name of a printer the text dimensions and capabilities of which are used to format the document.
GetPagesGets a collection of all pages in the document.
HeadersAndFootersGets a collection of all headers and footers the current document contains.
HypertextLinksGets a collection of all hypertext links contained in the main text of the document.
ImagesGets a collection of all images contained in the main text of the document.
InlineStylesGets a collection of all inline styles the current document contains.
InputPositionGets or sets the current text input position.
IsSpellCheckingEnabledGets or sets a value indicating whether spell checking is active or not.
LandscapeGets or sets a value indicating whether the page orientation is landscape or portrait.
LinesGets a collection of all lines contained in the main text of the document.
ListFormatGets or sets the type and the formatting attributes of a bulleted or numbered list.
MisspelledWordsGets a collection of all misspelled words in the main text of the document.
PageMarginsGets or sets the margins for the pages of the current document.
PagesGets the number of pages contained in the current document.
PageSizeSpecifies the width and height of the pages for the current document.
PageUnitGets or sets the measure used for page sizes and page margins.
ParagraphFormatGets or sets the paragraph formatting attributes of the text displayed by the control.
ParagraphsGets a collection of all paragraphs contained in the main text of the document.
ParagraphStylesGets a collection of all paragraph styles the current document contains.
SectionsGets a collection of all sections in the document.
SelectionGets or sets the current selection in the main text of the document.
SpellCheckerSpecifies the spell checking component to be used with a ServerTextControl.
TablesGets a collection of all tables contained in the main text of the document.
TextGets or sets the control's text.
TextBackColorGets or sets the background color for the text.
TextCharsGets a collection of all characters contained in the main text of the document.
TextFieldsGets a collection of all standard text fields contained in the main text of the document.
TextFramesGets a collection of all text frames the current document contains.
TextPartsGets a collection of all text parts the current document contains.

Methods

MethodDescription
AppendLoads text in a certain format from a file, a byte array or a string and appends it to the existing document.
ClearClears the selected text or the character right from the current input position.
CreateInitializes the resources of a newly instantiated object.
FindFinds a text string in the main text of the document.
GetSupportedFontsGets an array of strings specifying the names of all currently supported fonts.
GetXmlElementsReturns a collection of XML elements.
LoadLoads text in a certain format from a file, a byte array or a string.
OnAdaptFontRaises the AdaptFont event.
OnImageCreatedRaises the ImageCreated event.
OnImageDeletedRaises the ImageDeleted event.
OnSpellCheckTextRaises the SpellCheckText event.
OnTableCreatedRaises the TableCreated event.
OnTableDeletedRaises the TableDeleted event.
OnTextFrameCreatedRaises the TextFrameCreated event.
OnTextFrameDeletedRaises the TextFrameDeleted event.
OnXmlInvalidRaises the XmlInvalid event.
OnXmlNotWellFormedRaises the XmlNotWellFormed event.
PrintOverloaded. Prints a Text Control document or a part of a document.
ResetBackColorResets the BackColor property to its default value.
ResetContentsDeletes the entire contents of the control.
ResetFontResets the Font property to its default value.
ResetForeColorResets the ForeColor property to its default value.
ResetPageMarginsResets the PageMargins property to its default value.
ResetPageSizeResets the PageSize property to its default value.
ResetTextBackColorResets the TextBackColor property to its default value.
SaveSaves text in a certain format in a file, in a byte array or as a string.
SelectSelects text within the control.
SelectAllSelects all text in the control.

Events

EventDescription
AdaptFontOccurs for each font that must be adapted, because it is not supported.
ImageCreatedOccurs when a new image has been created.
ImageDeletedOccurs when an image has been deleted.
SpellCheckTextOccurs, if the document's text has been altered and the spelling of the new text must be checked.
TableCreatedOccurs for each table when a document is loaded containing tables.
TableDeletedOccurs after a table has been deleted.
TextFrameCreatedOccurs when a new text frame has been created.
TextFrameDeletedOccurs when a text frame has been deleted.
XmlInvalidOccurs when a loaded or changed XML document cannot be validated with the document type definition (DTD) referenced in the document.
XmlNotWellFormedOccurs when a loaded XML document is not well-formed.
 
 
 

Products

Support

Downloads

Corporate

Buy Now