TXTextControl.ServerVisualization.TextViewGenerator Class

The TextViewGenerator class is a special ServerTextControl, which can be used to visualize the control's text contents through a generated image. It manages a ServerVisualization.UserInput and a ServerVisualization.View object. These objects can be used to inform the generator about user input and to get a generated view depending on the input. A TextViewGenerator object can be connected with a StatusBarViewGenerator and with a RulerBarViewGenerator object to show formatting attributes and status information at the curent text input position.

Introduced: 21.0.

Syntax

[C#]
public class TextViewGenerator : ServerTextControl
[Visual Basic]
Public Class TextViewGenerator
  Inherits ServerTextControl

Properties

Property Description
ActivationState Gets or sets a value indicating the current activation state.
AllowDrag Gets or sets a value indicating whether the view generator can be a source of a Drag&Drop operation.
AllowDrop Gets or sets a value indicating whether the view generator can accept data that the user drags onto it.
AllowUndo Gets or sets a value indicating whether the undo buffer is active or not.
CanCopy Informs whether a part of a document has been selected and can be copied to the clipboard.
CanPaste Informs whether the clipboard contains a format that can be pasted into a document.
CanRedo Informs whether an operation can be re-done.
CanUndo Gets a value indicating whether the user can undo the previous operation.
ControlChars Specifies if control characters are visible or not.
DisplayColors Gets or sets display colors.
DocumentTargetMarkers Gets or sets a value indicating that markers for hypertext targets are shown or not.
DrawingMarkerLines Specifies whether a marker frame is shown around a drawing to indicate its position and size.
EditMode Gets or sets a value indicating whether the document's text is read-only, can be selected or is editable.
InputFormat Gets an object of the type InputFormat which represents all formatting attributes at the current text input position.
Location Gets or sets a location, in pixels.
RedoActionName Gets a string that represents the name of the action that will be performed when a call to the Redo method is made.
RulerBar Specifies the horizontal ruler bar to be used with the TextViewGenerator.
StatusBar Specifies the status bar to be used with the TextViewGenerator.
TextFrameMarkerLines Specifies whether text frames that have no border line are shown with marker lines.
UndoActionName Gets a string that represents the name of the action that will be performed when a call to the Undo method is made.
UserInput Gets the UserInput object, which can be used to inform the TextViewGenerator about user input.
VerticalRulerBar Specifies the vertical ruler bar to be used with the TextViewGenerator.
View Gets the View object, which informs about view changes and provides an image of the TextViewGenerator's current state.

Methods

Method Description
BeginUndoAction Begins a user-defined undo operation.
EndUndoAction Ends a user-defined undo operation.
GetDialogBox Overloaded. Returns a view generator for the specified built-in dialog box.
OnBarcodeDeselected Raises the BarcodeDeselected event.
OnBarcodeSelected Raises the BarcodeSelected event.
OnCaretStateChanged Raises the CaretStateChanged event.
OnChanged Raises the Changed event.
OnCharFormatChanged Raises the CharFormatChanged event.
OnChartDeselected Raises the ChartDeselected event.
OnChartSelected Raises the ChartSelected event.
OnDocumentLinkClicked Raises the DocumentLinkClicked event.
OnDocumentSizeChanged Raises the DocumentSizeChanged event.
OnDrawingDeselected Raises the DrawingDeselected event.
OnDrawingSelected Raises the DrawingSelected event.
OnDrawShape Raises the DrawShape event.
OnHeaderFooterActivated Raises the HeaderFooterActivated event.
OnHeaderFooterDeactivated Raises the HeaderFooterDeactivated event.
OnHypertextLinkClicked Raises the HypertextLinkClicked event.
OnImageDeselected Raises the ImageDeselected event.
OnImageSelected Raises the ImageSelected event.
OnInputPositionChanged Raises the InputPositionChanged event.
OnPageFormatChanged Raises the PageFormatChanged event.
OnParagraphFormatChanged Raises the ParagraphFormatChanged event.
OnSubTextPartClicked Raises the SubTextPartClicked event.
OnSubTextPartDoubleClicked Raises the SubTextPartDoubleClicked event.
OnSubTextPartEntered Raises the SubTextPartEntered event.
OnSubTextPartLeft Raises the SubTextPartLeft event.
OnTextContextMenuOpening Raises the TextContextMenuOpening event.
OnTextFieldClicked Raises the TextFieldClicked event.
OnTextFieldEntered Raises the TextFieldEntered event.
OnTextFieldLeft Raises the TextFieldLeft event.
OnTextFrameDeselected Raises the TextFrameDeselected event.
OnTextFrameSelected Raises the TextFrameSelected event.
Redo Redoes the last TextViewGenerator operation.
Undo Undoes the last edit operation in the TextViewGenerator.
Zoom Overloaded. Zooms the contents of the TextViewGenerator.

Events

Event Description
BarcodeDeselected Occurs when a barcode has been deselected.
BarcodeSelected Occurs when a barcode has been selected.
CaretStateChanged Occurs when the state of the caret (size, position, visibility) has been changed.
Changed Indicates that the contents of a document have been changed.
CharFormatChanged Occurs when the character formatting attributes either of the selected characters or the current text input position have been changed.
ChartDeselected Occurs when a chart has been deselected.
ChartSelected Occurs when a chart has been selected.
DocumentLinkClicked Occurs when a text field has been clicked on that represents a link to a target in the document.
DocumentSizeChanged Occurs when the size of the document has been changed.
DrawingDeselected Occurs when a drawing has been deselected.
DrawingSelected Occurs when a drawing has been selected.
DrawShape Occurs when additional user-interaction parts must be drawn.
HeaderFooterActivated Occurs when a header or footer has been activated.
HeaderFooterDeactivated Occurs when a header or footer has been deactivated.
HypertextLinkClicked Occurs when a text field has been clicked on that represents the source of a hypertext link.
ImageDeselected Occurs when an image has been deselected.
ImageSelected Occurs when an image has been selected.
InputPositionChanged Occurs when the text input position has been changed.
PageFormatChanged Occurs when the page format settings have been changed.
ParagraphFormatChanged Occurs when the formatting attributes of the selected paragraphs have been changed.
SubTextPartClicked Occurs when a subtextpart has been clicked on.
SubTextPartDoubleClicked Occurs when a subtextpart has been double-clicked on.
SubTextPartEntered Occurs when the current input position has been moved to a position that belongs to a subtextpart.
SubTextPartLeft Occurs when the current input position has left a subtextpart.
TextContextMenuOpening Occurs when a right mouse click is sent as user input and a context menu should be opened.
TextControl.TextFieldClicked Occurs when a text field has been clicked on.
TextFieldEntered Occurs when the current input position has been moved to a position that belongs to a text field.
TextFieldLeft Occurs when the current input position has left a text field.
TextFrameDeselected Occurs when a text frame has been deselected.
TextFrameSelected Occurs when a text frame has been selected.

Enumerations

Enumeration Description
DialogBoxKind Determines a built-in dialog box.

See Also