VisRichEdit

PPJ.Runtime.Vis.VisRichEdit

Namespace: PPJ.Runtime.Vis

Assembly: PPJ.Runtime.Vis.49 (4.9.0.0)

Rich edit control

C#

public class VisRichEdit : RichTextBox, ISalWindow

VB.NET

Constructors

VisRichEdit()

Default Constructor.

Properties

EnableSpellChecker

Boolean: Enables/Disables the built-in spell checker. (Default: False)

NamedProperties

SalNamedProperties: Returns the collection of named properties.

Text

String: Returns/Sets the text of the data field.

Methods

BringWindowToTop()

Brings a window to the top of all overlapping windows.

Returns: SalBoolean.

CenterWindow()

Centers a window. If the window is a top-level window, it centers it on the desktop. If the window is a child window, it centers it on top of its parent.

Returns: SalBoolean.

ClearCursor(type)

Clears a window's cursor.

Parameter	Type	Description
type	SalNumber

Returns: SalBoolean.

ConvertFromRTF(sRTFText)

Convert the specified RTF text into text formatting and display the rich text in the control.

Parameter	Type	Description
sRTFText	SalString

Returns: SalBoolean.

ConvertToRTF()

Convert the contents of the control into RTF text.

Returns: SalString.

DestroyWindow()

Destroys a form window, a top-level table window, or a modeless dialog box created with SalCreateWindow.

Returns: SalBoolean.

DisableWindow()

Disables keyboard and mouse input to a window. If the window contains text (for example, a push button), the text is grayed. If the window is a data field, it cannot receive the focus.

Returns: SalBoolean.

EnableWindow()

Enables keyboard and mouse input to a window.

Returns: SalBoolean.

FindChild(windowName)

This function finds a child window of a given name in the specified window.

Parameter	Type	Description
windowName	SalString

Returns: SalWindowHandle.

FindText(nSearchFlags, sSearchText)

Searches the control for the specified text.

Parameter	Type	Description
nSearchFlags	SalNumber
sSearchText	SalString

Returns: SalNumber.

FormUnitsToPixels(formUnits, vertical)

Computes the number of pixels in the number of form units. Form units are a unit of measurement used by functions which move and position objects. Form units are computed using physical units (pixels) in conjunction with the window's font size.

Parameter	Type	Description
formUnits	SalNumber	The number of form units.
vertical	SalBoolean	If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.

Returns: SalNumber.

FromHandle(handle)

Returns the control associated with the handle.

Parameter	Type	Description
handle	SalWindowHandle

Returns: VisRichEdit.

GetClassName()

Return the name of a window's class as a string.

Returns: SalString.

GetControlType()

Returns an object's type.

Returns: SalNumber.

GetDefaultCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Parameter	Type	Description
sFontName	SalString&
nPointSize	SalNumber&
nEnhFlags	SalNumber&
nTextColor	SalNumber&

Returns: SalBoolean.

GetFirstChild(typeMask)

Returns the handle of the first child window of the specified type. You can use this function to get the handles of MDI child windows.

Parameter	Type	Description
typeMask	SalNumber	One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetFirstVisibleLine()

Returns the topmost visible line number.

Returns: SalNumber.

GetFont(name, size, enhancement)

Parameter	Type	Description
name	SalString&
size	SalNumber&
enhancement	SalNumber&

Returns: SalBoolean.

GetLimitText()

Gets the limit on the amount of text a user can enter.

Returns: SalNumber.

GetLine(nLineIndex)

Returns the specified line of text.

Parameter	Type	Description
nLineIndex	SalNumber

Returns: SalString.

GetLineCount()

Returns the number of lines of text in the control.

Returns: SalNumber.

GetLocation(x, y)

Parameter	Type	Description
x	SalNumber&
y	SalNumber&

Returns: SalBoolean.

GetModify()

Returns a flag indicating whether the contents have changed.

Returns: SalNumber.

GetName(text)

Parameter	Type	Description
text	SalString&

Returns: SalBoolean.

GetName()

Gets the name of an object.

Returns: SalString.

GetNextChild(typeMask)

Returns the handle of the next child window that matches a specified type.

Parameter	Type	Description
typeMask	SalNumber	One or more window types combined (using the OR (|) operator) to create a mask of child window types.

Returns: SalWindowHandle.

GetParaFormat(nLeftIndent, nRightIndent, nOffset, nAlignment, nNumbering, nTabStops, nNumTabs)

Parameter	Type	Description
nLeftIndent	SalNumber&
nRightIndent	SalNumber&
nOffset	SalNumber&
nAlignment	SalNumber&
nNumbering	SalNumber&
nTabStops	SalArray`1&
nNumTabs	SalNumber&

Returns: SalBoolean.

GetParent()

Returns the handle of an object's parent window.

Returns: SalWindowHandle.

GetProperty(name, value)

Parameter	Type	Description
name	SalString
value	SalString&

Returns: SalBoolean.

GetProperty(name)

Gets the value of a named property.

Parameter	Type	Description
name	SalString

Returns: SalString.

GetSel(nStart, nEnd)

Parameter	Type	Description
nStart	SalNumber&
nEnd	SalNumber&

Returns: SalBoolean.

GetSelectionCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Parameter	Type	Description
sFontName	SalString&
nPointSize	SalNumber&
nEnhFlags	SalNumber&
nTextColor	SalNumber&

Returns: SalBoolean.

GetSelectionType()

Returns flags indicating the selection type.

Returns: SalNumber.

GetSelText()

Returns the plain text of the current selection.

Returns: SalString.

GetSize(width, height)

Parameter	Type	Description
width	SalNumber&
height	SalNumber&

Returns: SalBoolean.

GetText()

Returns all plain text in the control (same as SalGetWindowText).

Returns: SalString.

GetText(text, maxLen)

Parameter	Type	Description
text	SalString&
maxLen	SalNumber

Returns: SalNumber.

GetText(maxLen)

Retrieves the text of a window.

Parameter	Type	Description
maxLen	SalNumber

Returns: SalString.

GetTextLength()

Returns the length of the plain text in the control. The text length does not include RTF formatting.

Returns: SalNumber.

GetWindowColor(colorIndex)

Gets a window's color.

Parameter	Type	Description
colorIndex	SalNumber

Returns: SalNumber.

GetWindowState()

Returns a window's current state.

Returns: SalNumber.

HideSelection(bHide, bPermanent)

Hide or show the current selection.

Parameter	Type	Description
bHide	SalBoolean
bPermanent	SalBoolean

Returns: SalBoolean.

HideWindow()

Hides a window.

Returns: SalBoolean.

InvalidateWindow()

Causes a window to be repainted.

Returns: SalBoolean.

IsDerivedFromClass(typeClass)

Determines whether a window is an instance of the specified class.

Parameter	Type	Description
typeClass	Type

Returns: SalBoolean.

IsEnabled()

Determines whether a window is enabled for mouse and keyboard input.

Returns: SalBoolean.

IsVisible()

Determines whether a window is currently visible.

Returns: SalBoolean.

KillTimer(idEvent)

Destroys an object's system timer.

Parameter	Type	Description
idEvent	SalNumber

Returns: SalBoolean.

LimitText(nTextLimit)

Limits the amount of text a user can enter into the object. Changing the text limit restricts only the text the user can enter. It has no effect on any text already in the control, nor does it affect the length of the text that may be copied into the control.

Parameter	Type	Description
nTextLimit	SalNumber

Returns: SalBoolean.

LineFromChar(nCharIndex)

Return the line number of the line that contains the specified character index.

Parameter	Type	Description
nCharIndex	SalNumber

Returns: SalNumber.

LineIndex(nLine)

Return the character index of the specified line. The character index is the number of characters from the beginning of the control to the specified line.

Parameter	Type	Description
nLine	SalNumber

Returns: SalNumber.

LineLength(nLineIndex)

Returns the length (in characters) of the specified line.

Parameter	Type	Description
nLineIndex	SalNumber

Returns: SalNumber.

LineScroll(nLines, nChars)

Scrolls the text vertically or horizontally.

Parameter	Type	Description
nLines	SalNumber
nChars	SalNumber

Returns: SalBoolean.

MoveWindow(xOffset, yOffset)

Moves a window a given number of form units on the X and Y axes relative to its current position.

Parameter	Type	Description
xOffset	SalNumber
yOffset	SalNumber

Returns: SalBoolean.

PixelsToFormUnits(numPixels, vertical)

Computes the number of form units based on the number of pixels. Form units are a unit of measurement used by functions that move and position objects. Form units are computed using physical units (pixels) in conjunction with a window's font sizes.

Parameter	Type	Description
numPixels	SalNumber
vertical	SalBoolean	If the form units are on the X axis, set this parameter to FALSE. If the form units are on the Y axis, set this parameter to TRUE.

Returns: SalNumber.

PostMessage(msg, mywParam, mylParam)

Posts the specified message to a window by adding nMsg to hWndReceiver's message queue.

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalBoolean.

ReplaceSel(sText)

Replaces the current selection with the specified text.

Parameter	Type	Description
sText	SalString

Returns: SalBoolean.

SendMessage(msg, mywParam, mylParam)

Sends the specified message to a window. SalSendMsg does not return until the processing for the message is complete.

Parameter	Type	Description
msg	SalNumber
mywParam	SalNumber
mylParam	SalNumber

Returns: SalNumber.

SendMessageToChildren(nMsg, nMywParam, nMylParam)

Sends a message to all child items of a form window, dialog box, table window, or MDI window.

Parameter	Type	Description
nMsg	SalNumber
nMywParam	SalNumber
nMylParam	SalNumber

Returns: SalBoolean.

SetContextMenu(sMenuName, nFlags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter	Type	Description
sMenuName	SalString
nFlags	SalNumber

Returns: SalBoolean.

SetContextMenu(menuType, flags)

Defines a named popup menu that displays automatically when a window receives SAM_ContextMenu.

Parameter	Type	Description
menuType	Type
flags	SalNumber

Returns: SalBoolean.

SetCursor(resource, type)

Sets a window's cursor.

Parameter	Type	Description
resource	SalResourceCursor
type	SalNumber

Returns: SalBoolean.

SetCursor(resourceId, type)

Sets a window's cursor.

Parameter	Type	Description
resourceId	Int32
type	SalNumber

Returns: SalBoolean.

SetCursor(blob, type)

Sets a window's cursor from a string variable.

Parameter	Type	Description
blob	SalString
type	SalNumber

Returns: SalBoolean.

SetCursorFile(file, type)

Sets an application-defined cursor for the specified window. Use this function to set the cursor from an image stored in a file.

Parameter	Type	Description
file	SalString
type	SalNumber

Returns: SalBoolean.

SetDefaultCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Sets the default character formatting.

Parameter	Type	Description
sFontName	SalString
nPointSize	SalNumber
nEnhFlags	SalNumber
nTextColor	SalNumber

Returns: SalBoolean.

SetFocus()

Sets the focus to a specified window.

Returns: SalWindowHandle.

SetFont(name, size, enhancement)

Sets a window's font, font size, and font enhancements.

Parameter	Type	Description
name	SalString
size	SalNumber
enhancement	SalNumber

Returns: SalBoolean.

SetLocation(x, y)

Moves a window to a new position (x, y) on the X and Y axes.

Parameter	Type	Description
x	SalNumber
y	SalNumber

Returns: SalBoolean.

SetModify(bState)

Sets or clears the modification flag for the control.

Parameter	Type	Description
bState	SalBoolean

Returns: SalBoolean.

SetOptions(nOptions)

Sets options for the Rich Edit control (see REF flag definitions in global constants).

Parameter	Type	Description
nOptions	SalNumber

Returns: SalBoolean.

SetParaFormat(nLeftIndent, nRightIndent, nOffset, nAlignment, nNumbering, nTabStops, nNumTabs)

Sets the paragraph formatting for the first paragraph in the current selection.

Parameter	Type	Description
nLeftIndent	SalNumber
nRightIndent	SalNumber
nOffset	SalNumber
nAlignment	SalNumber
nNumbering	SalNumber
nTabStops	SalArray<SalNumber>
nNumTabs	SalNumber

Returns: SalBoolean.

SetProperty(name, value, length)

Sets the value of a named property.

Parameter	Type	Description
name	SalString
value	SalString
length	SalNumber

Returns: SalBoolean.

SetSel(nStart, nEnd)

Sets the selected (highlighted) text.

Parameter	Type	Description
nStart	SalNumber
nEnd	SalNumber

Returns: SalBoolean.

SetSelectionCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Sets the character formatting for the current selection.

Parameter	Type	Description
sFontName	SalString
nPointSize	SalNumber
nEnhFlags	SalNumber
nTextColor	SalNumber

Returns: SalBoolean.

SetSize(width, height)

Resizes a window.

Parameter	Type	Description
width	SalNumber
height	SalNumber

Returns: SalBoolean.

SetText(text)

Sets the text of a window.

Parameter	Type	Description
text	SalString

Returns: SalBoolean.

SetTimer(idEvent, elapseMilliSec)

Creates a system timer for a given object. When a timer event occurs, sends SAM_Timer messages to the object in specified intervals. Timers are a limited global resource. Your application must check the value returned by SalTimerSet to verify that the timer was created.

Parameter	Type	Description
idEvent	SalNumber
elapseMilliSec	SalNumber

Returns: SalBoolean.

SetWindowColor(colorIndex, color)

Sets a window's color.

Parameter	Type	Description
colorIndex	SalNumber
color	SalNumber

Returns: SalBoolean.

ShowWindow()

Makes a window visible.

Returns: SalBoolean.

TrackPopupMenu(menuName, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuName	SalString
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

TrackPopupMenu(menuType, flags, x, y)

Creates pop-up menus at runtime.

Parameter	Type	Description
menuType	Type
flags	SalNumber
x	SalNumber
y	SalNumber

Returns: SalBoolean.

UpdateWindow()

Forces the update of a window.

Returns: SalBoolean.

WinHelp(file, command, numData, strData)

Starts the Windows help system.

Parameter	Type	Description
file	SalString
command	SalNumber
numData	SalNumber
strData	SalString

Returns: SalBoolean.

Yield()

Processes messages for this control.

Events

MessageActions

SalMessageHandler Message Actions

WindowActions

WindowActionsEventHandler Window Actions

Implements

Name	Description
ISalWindow