RichEdit Class (Typed)

Create a rich edit control.

Inheritance Hierarchy

Object
  VObject
    Control
      TextControl
        Edit
          MultiLineEdit
            RichEdit

Namespace: XSharp.VO.SDK
Assembly: XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.24 GA

Syntax

Copy

 CLASS RichEdit INHERIT MultiLineEdit

public class RichEdit : MultiLineEdit

Request Example View Source

The RichEdit type exposes the following members.

Constructors

	Name	Description
	RichEdit	Construct a rich edit.

Top

Properties

	Name	Description
	Alignment	A constant representing the paragraph alignment of the rich edit:
	Background	(Overrides Background.)
	BackgroundColor	A Color object representing the background color of the rich edit
	Margins	A Dimension object specifying the left and right margins of the edit control. (Overrides Margins.)
	Numbering	A constant representing the type of paragraph numbering currently associated with the rich edit:
	PrimaryIndent	A numeric value representing the indent of the first line of a paragraph in the rich edit.
	Protected	A logical value that is TRUE if the text in the rich edit is protected from modification.
	RightMargin	A numeric value representing the right margin of the rich edit.
	SecondaryIndent	A numeric value representing the indent of the second and subsequent lines of a paragraph in the rich edit.
	SelectedText	A string representing the currently selected text in the rich edit. (Overrides SelectedText.)
	Selection	A Selection object representing the currently selected text in the rich edit. (Overrides Selection.)
	SelectionType	A constant representing the type of the current selection in the rich edit:
	TabStopCount	A numeric value representing the number of tab stops in the rich edit.
	TextColor	A Color object representing the text color of the rich edit. (Overrides TextColor.)
	TextLimit	A numeric value representing the maximum amount of text in the rich edit. The default is 32KB. (Overrides TextLimit.)
	Value	A string representing the text contents of the rich edit (Overrides Value.)

Top

Functions

	Name	Description
	CanPaste	Determine whether the rich edit can paste the specified clipboard format.
	EnableAdvancedTypography	Sets the ability for advanced line breaking and line formatting.
	GetOption	Determine the status of a particular option for the rich edit.
	GetTabStops	Set the TabStops for a rich edit control.
	GetTextRange	Retrieve a range of characters from the rich edit.
	GetWordBreak	Locate a particular type of word break in the rich edit.
	HideSelection	Hide the selection in the rich edit.
	LineFromCharacter	Determine the line number of the rich edit from the specified character position.
	LoadFromFile(String)	Load data from an RTF file into the rich edit control.
	LoadFromFile(String, Long)	Load data from an RTF file into the rich edit control.
	Margin	Set the margins for the currently selected text in the rich edit control.
	PasteSpecial	Paste a particular clipboard format in the rich edit.
	Print	Print the contents of the rich edit.
	SaveToFile	Save the current contents of the control to an RTF file.
	Seek	Search the rich edit for the specified text.
	SetOption	Set an option for the rich edit.
	SetTabStops	Set the TabStops for a rich edit control.
	ShowSelection	Show the selection in the rich edit.

Top

Remarks

A rich edit is a control in which the user can enter and edit text. The text can be assigned character and paragraph formatting, as well as background and foreground color. The rich edit provides a programming interface for printing and searching for text and word breaks.

Reference

XSharp.VO.SDK Namespace