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. |
|
| Syntax: |
|
[C#]
public class ServerTextControl : Component
[Visual Basic]
Public Class ServerTextControl
Inherits Component
|
| Introduced: |
|
12.0
|
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.
|
| Baseline |
|
Gets or sets the baseline alignment, in twips, of the control.
|
| 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.
|
| Font |
|
Gets or sets the control's font.
|
| FontUnderlineStyle |
|
Gets or sets underlining style for the text displayed by the control.
|
| ForeColor |
|
Gets or sets the foreground color of the control.
|
| 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 in the document.
|
| Images |
|
Gets a collection of all images the current document contains.
|
| InlineStyles |
|
Gets a collection of all inline styles the current document contains.
|
| InputPosition |
|
Gets or sets the current text input position.
|
| Landscape |
|
Gets or sets a value indicating whether the page orientation is landscape or portrait.
|
| Lines |
|
Gets a collection of all lines in the current document.
|
| ListFormat |
|
Gets or sets the type and the formatting attributes of a bulleted or numbered list.
|
| PageMargins |
|
Gets or sets the margins for the pages, in 1/100 inch, of the current document.
|
| Pages |
|
Gets the number of pages contained in the current document.
|
| PageSize |
|
Specifies the width and height of the pages, in 1/100 inch, for 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.
|
| Sections |
|
Gets a collection of all sections in the document.
|
| Selection |
|
Gets or sets the current selection in the control.
|
| Tables |
|
Gets a collection of all tables 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 in the current document.
|
| TextControl.FormattingPrinter |
|
Gets or sets the name of a printer the text dimensions and capabilities of which are used to format the document.
|
| TextFields |
|
Gets a collection of all standard text fields in the document.
|
| TextFrames |
|
Gets a collection of all text frames the current document contains.
|
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 left from the current input position.
|
| Create |
|
Initializes the resources of a newly instantiated object.
|
| Find |
|
Finds a text string in a Text Control document.
|
| GetXmlElements |
|
Returns a collection of XML elements.
|
| Load |
|
Loads text in a certain format from a file, a byte array or a string.
|
| OnImageCreated |
|
Raises the ImageCreated event.
|
| OnImageDeleted |
|
Raises the ImageDeleted 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 |
|
Saves text in a certain format in a file, in a byte array or as a string.
|
| Select |
|
Selects text within the control.
|
| SelectAll |
|
Selects all text in the control.
|
Events |
| Event |
|
Description |
|
| |
| ImageCreated |
|
Occurs when a new image has been created.
|
| ImageDeleted |
|
Occurs when an image has been deleted.
|
| TableCreated |
|
Occurs for each table when a document is loaded containing tables.
|
| 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.
|
