PPJ Desktop API
HomeCurrent IssuesDownloads
  • Welcome
  • Concepts
  • PPJ.Runtime.49
    • General
      • Sal
      • Sys
      • SalApplication
      • SalNamedProperties
      • SalWindow
      • WindowActionsEventArgs
      • SalXML
    • COM
      • SalCoClass
      • SalObject
      • SalOleErrorInfo
      • SalSafeArray
      • SalVariant
    • Controls
      • SalActiveX
      • SalBackgroundText
      • SalCheckBox
      • SalComboBox
      • SalContext
      • SalCustomControl
      • SalDataField
        • DataType
      • SalFrame
        • BorderStyle
      • SalGeneralWindow
      • SalGroupBox
      • SalGroupSeparator
      • SalHorizontalScrollBar
      • SalLine
        • LineStyle
        • LineType
      • SalListBox
      • SalMultilineField
      • SalNavigationBar
      • SalOptionButton
        • OptionButtonStyle
      • SalPicture
        • ImageStorage
      • SalPushbutton
      • SalRadioButton
      • SalTableWindow
        • CellType
        • FocusRowStyle
        • RowsSizingStyle
        • SalTableColumn
        • SalTableColumnCollection
        • SalTableRow
        • SalTableRowCollection
        • SalTableWindowBase
      • SalTreeControl
        • SalTreeItem
      • SalUserControl
      • SalVerticalScrollBar
    • Forms
      • AccessoryType
      • SalDialogBox
      • SalForm
      • SalFormClientArea
      • SalFormStatusBar
      • SalFormTableWindow
      • SalFormToolBar
      • SalFormWindow
      • SalMDIWindow
      • SalRibbonBarBase
      • SalRibbonBarForm
      • SalRibbonBarMDI
      • SalRibbonStatusBar
    • Interfaces
      • ISalControl
      • ISalEditControl
      • ISalListControl
      • ISalPictureControl
      • ISalRadioButton
      • ISalReport
      • ISalType
      • ISalAccessory
      • ISalMenu
      • ISalWindow
    • Internet
      • FtpEventArgs
      • FtpEventHandler
      • HttpEventArgs
      • HttpEventHandler
      • SalFtpClient
      • SalHttpClient
      • SalQuickFTP
      • SalQuickHTTP
    • Menus
      • SalContextMenu
      • SalFormMainMenu
      • SalMenuColumn
      • SalMenuItem
      • SalMenuRow
      • SalMenuSeparator
      • SalPopupMenu
      • SalWindowsMenu
    • QO
      • QO
      • SalQuickHTML
      • SalQuickTabs
      • SalQuickTabsDialog
      • SalQuickTabsForm
      • SalQuickTabsParent
      • SalQuickTabsParentDialog
      • SalQuickTabsParentForm
      • SalQuickToolTipCheckBox
      • SalQuickToolTipChildTable
      • SalQuickToolTipComboBox
      • SalQuickToolTipDataField
      • SalQuickToolTipHScrollBar
      • SalQuickToolTipListBox
      • SalQuickToolTipMultilineField
      • SalQuickToolTipOptionButton
      • SalQuickToolTipPicture
      • SalQuickToolTipPushButton
      • SalQuickToolTipRadioButton
      • SalQuickToolTipTableWindow
      • SalQuickToolTipVScrollBar
      • SalToolTipManager
    • Sql
      • SalSqlBindVariables
      • SalSqlError
      • SalSqlHandle
      • SalSqlSessionHandle
      • Sql
      • SqlContext
      • SqlOra
      • WhenSqlError
    • Types
      • SalArray
      • SalArray<T>
      • SalBinary
      • SalBoolean
      • SalDateTime
      • SalFileHandle
      • SalFunctionalClass
      • SalNumber
      • SalResource
      • SalString
      • SalStringContext
      • SalWindowHandle
  • PPJ.Runtime.DDE.49
    • General
      • SalDDE
  • PPJ.Runtime.Vis.49
    • General
      • Vis
      • VisTblEx
    • Controls
      • VisCalendar
      • VisCalendarDropDown
      • VisColorComboBox
      • VisColorListBox
      • VisColorPalette
      • VisColorPaletteBase
      • VisColorPaletteDropDown
      • VisComboBoxBase
      • VisDesktopListBox
      • VisDirListBox
      • VisDirTreeListBox
      • VisDriveListBox
      • VisDropDownBase
      • VisFileListBox
      • VisFontComboBox
      • VisFontListBox
      • VisFontNameComboBox
      • VisFontNameListBox
      • VisListBoxBase
      • VisListBoxExtension
      • VisListView
      • VisListViewDropDown
      • VisMeter
      • VisOutlineComboBox
      • VisOutlineListBox
      • VisPictureComboBox
      • VisPictureListBox
      • VisPoint
      • VisRadioListBox
      • VisRect
      • VisRichEdit
      • VisSize
      • VisSpinField
      • VisSplitter
      • VisSplitterWindow
        • Orientation
  • PPJ.Runtime.XSal.49
    • General
      • XSal
      • XSalScript
    • Controls
      • XSalFlatButton
      • XSalHSplitter
      • XSalSeparator
      • XSalSeparatorDoubleRaised
      • XSalSeparatorEtched
      • XSalSeparatorInvisible
      • XSalSeparatorSingleRaised
      • XSalSplitter
      • XSalToolbar
      • XSalToolbox
      • XSalVSplitter
Powered by GitBook
On this page
  • Constructors
  • VisRichEdit()
  • Properties
  • EnableSpellChecker
  • NamedProperties
  • Text
  • Methods
  • BringWindowToTop()
  • CenterWindow()
  • ClearCursor(type)
  • ConvertFromRTF(sRTFText)
  • ConvertToRTF()
  • DestroyWindow()
  • DisableWindow()
  • EnableWindow()
  • FindChild(windowName)
  • FindText(nSearchFlags, sSearchText)
  • FormUnitsToPixels(formUnits, vertical)
  • FromHandle(handle)
  • GetClassName()
  • GetControlType()
  • GetDefaultCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)
  • GetFirstChild(typeMask)
  • GetFirstVisibleLine()
  • GetFont(name, size, enhancement)
  • GetLimitText()
  • GetLine(nLineIndex)
  • GetLineCount()
  • GetLocation(x, y)
  • GetModify()
  • GetName(text)
  • GetName()
  • GetNextChild(typeMask)
  • GetParaFormat(nLeftIndent, nRightIndent, nOffset, nAlignment, nNumbering, nTabStops, nNumTabs)
  • GetParent()
  • GetProperty(name, value)
  • GetProperty(name)
  • GetSel(nStart, nEnd)
  • GetSelectionCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)
  • GetSelectionType()
  • GetSelText()
  • GetSize(width, height)
  • GetText()
  • GetText(text, maxLen)
  • GetText(maxLen)
  • GetTextLength()
  • GetWindowColor(colorIndex)
  • GetWindowState()
  • HideSelection(bHide, bPermanent)
  • HideWindow()
  • InvalidateWindow()
  • IsDerivedFromClass(typeClass)
  • IsEnabled()
  • IsVisible()
  • KillTimer(idEvent)
  • LimitText(nTextLimit)
  • LineFromChar(nCharIndex)
  • LineIndex(nLine)
  • LineLength(nLineIndex)
  • LineScroll(nLines, nChars)
  • MoveWindow(xOffset, yOffset)
  • PixelsToFormUnits(numPixels, vertical)
  • PostMessage(msg, mywParam, mylParam)
  • ReplaceSel(sText)
  • SendMessage(msg, mywParam, mylParam)
  • SendMessageToChildren(nMsg, nMywParam, nMylParam)
  • SetContextMenu(sMenuName, nFlags)
  • SetContextMenu(menuType, flags)
  • SetCursor(resource, type)
  • SetCursor(resourceId, type)
  • SetCursor(blob, type)
  • SetCursorFile(file, type)
  • SetDefaultCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)
  • SetFocus()
  • SetFont(name, size, enhancement)
  • SetLocation(x, y)
  • SetModify(bState)
  • SetOptions(nOptions)
  • SetParaFormat(nLeftIndent, nRightIndent, nOffset, nAlignment, nNumbering, nTabStops, nNumTabs)
  • SetProperty(name, value, length)
  • SetSel(nStart, nEnd)
  • SetSelectionCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)
  • SetSize(width, height)
  • SetText(text)
  • SetTimer(idEvent, elapseMilliSec)
  • SetWindowColor(colorIndex, color)
  • ShowWindow()
  • TrackPopupMenu(menuName, flags, x, y)
  • TrackPopupMenu(menuType, flags, x, y)
  • UpdateWindow()
  • WinHelp(file, command, numData, strData)
  • Yield()
  • Events
  • MessageActions
  • WindowActions
  • Implements
  1. PPJ.Runtime.Vis.49
  2. Controls

VisRichEdit

PPJ.Runtime.Vis.VisRichEdit

PreviousVisRectNextVisSize

Last updated 2 years ago

Namespace: PPJ.Runtime.Vis

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

Rich edit control

public class VisRichEdit : RichTextBox, ISalWindow
Public Class VisRichEdit
    Inherits RichTextBox
    Implements ISalWindow

Constructors

VisRichEdit()

Default Constructor.

Properties

EnableSpellChecker

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

NamedProperties

: Returns the collection of named properties.

Text

Methods

Brings a window to the top of all overlapping windows.

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.

Clears a window's cursor.

Parameter
Type
Description

type

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

Parameter
Type
Description

sRTFText

Convert the contents of the control into RTF text.

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

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.

Enables keyboard and mouse input to a window.

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

Parameter
Type
Description

windowName

Searches the control for the specified text.

Parameter
Type
Description

nSearchFlags

sSearchText

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

The number of form units.

vertical

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 the control associated with the handle.

Parameter
Type
Description

handle

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

Returns an object's type.

Parameter
Type
Description

sFontName

nPointSize

nEnhFlags

nTextColor

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

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

Returns the topmost visible line number.

Parameter
Type
Description

name

size

enhancement

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

Returns the specified line of text.

Parameter
Type
Description

nLineIndex

Returns the number of lines of text in the control.

Parameter
Type
Description

x

y

Returns a flag indicating whether the contents have changed.

Parameter
Type
Description

text

Gets the name of an object.

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

Parameter
Type
Description

typeMask

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

Parameter
Type
Description

nLeftIndent

nRightIndent

nOffset

nAlignment

nNumbering

nTabStops

nNumTabs

Returns the handle of an object's parent window.

Parameter
Type
Description

name

value

Gets the value of a named property.

Parameter
Type
Description

name

Parameter
Type
Description

nStart

nEnd

Parameter
Type
Description

sFontName

nPointSize

nEnhFlags

nTextColor

Returns flags indicating the selection type.

Returns the plain text of the current selection.

Parameter
Type
Description

width

height

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

Parameter
Type
Description

text

maxLen

Retrieves the text of a window.

Parameter
Type
Description

maxLen

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

Gets a window's color.

Parameter
Type
Description

colorIndex

Returns a window's current state.

Hide or show the current selection.

Parameter
Type
Description

bHide

bPermanent

Hides a window.

Causes a window to be repainted.

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

Parameter
Type
Description

typeClass

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

Determines whether a window is currently visible.

Destroys an object's system timer.

Parameter
Type
Description

idEvent

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

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

Parameter
Type
Description

nCharIndex

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

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

Parameter
Type
Description

nLineIndex

Scrolls the text vertically or horizontally.

Parameter
Type
Description

nLines

nChars

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

Parameter
Type
Description

xOffset

yOffset

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

vertical

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.

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

Parameter
Type
Description

msg

mywParam

mylParam

Replaces the current selection with the specified text.

Parameter
Type
Description

sText

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

Parameter
Type
Description

msg

mywParam

mylParam

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

Parameter
Type
Description

nMsg

nMywParam

nMylParam

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

Parameter
Type
Description

sMenuName

nFlags

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

Parameter
Type
Description

menuType

flags

Sets a window's cursor.

Parameter
Type
Description

resource

type

Sets a window's cursor.

Parameter
Type
Description

resourceId

type

Sets a window's cursor from a string variable.

Parameter
Type
Description

blob

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

type

Sets the default character formatting.

Parameter
Type
Description

sFontName

nPointSize

nEnhFlags

nTextColor

Sets the focus to a specified window.

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

Parameter
Type
Description

name

size

enhancement

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

Parameter
Type
Description

x

y

Sets or clears the modification flag for the control.

Parameter
Type
Description

bState

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

Parameter
Type
Description

nOptions

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

Parameter
Type
Description

nLeftIndent

nRightIndent

nOffset

nAlignment

nNumbering

nTabStops

nNumTabs

Sets the value of a named property.

Parameter
Type
Description

name

value

length

Sets the selected (highlighted) text.

Parameter
Type
Description

nStart

nEnd

Sets the character formatting for the current selection.

Parameter
Type
Description

sFontName

nPointSize

nEnhFlags

nTextColor

Resizes a window.

Parameter
Type
Description

width

height

Sets the text of a window.

Parameter
Type
Description

text

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

elapseMilliSec

Sets a window's color.

Parameter
Type
Description

colorIndex

color

Makes a window visible.

Creates pop-up menus at runtime.

Parameter
Type
Description

menuName

flags

x

y

Creates pop-up menus at runtime.

Parameter
Type
Description

menuType

flags

x

y

Forces the update of a window.

Starts the Windows help system.

Parameter
Type
Description

file

command

numData

strData

Processes messages for this control.

Events

Implements

Name
Description

: Returns/Sets the text of the data field.

BringWindowToTop()

Returns: .

CenterWindow()

Returns: .

ClearCursor(type)

Returns: .

ConvertFromRTF(sRTFText)

Returns: .

ConvertToRTF()

Returns: .

DestroyWindow()

Returns: .

DisableWindow()

Returns: .

EnableWindow()

Returns: .

FindChild(windowName)

Returns: .

FindText(nSearchFlags, sSearchText)

Returns: .

FormUnitsToPixels(formUnits, vertical)

Returns: .

FromHandle(handle)

Returns: .

GetClassName()

Returns: .

GetControlType()

Returns: .

GetDefaultCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Returns: .

GetFirstChild(typeMask)

Returns: .

GetFirstVisibleLine()

Returns: .

GetFont(name, size, enhancement)

Returns: .

GetLimitText()

Returns: .

GetLine(nLineIndex)

Returns: .

GetLineCount()

Returns: .

GetLocation(x, y)

Returns: .

GetModify()

Returns: .

GetName(text)

Returns: .

GetName()

Returns: .

GetNextChild(typeMask)

Returns: .

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

Returns: .

GetParent()

Returns: .

GetProperty(name, value)

Returns: .

GetProperty(name)

Returns: .

GetSel(nStart, nEnd)

Returns: .

GetSelectionCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Returns: .

GetSelectionType()

Returns: .

GetSelText()

Returns: .

GetSize(width, height)

Returns: .

GetText()

Returns: .

GetText(text, maxLen)

Returns: .

GetText(maxLen)

Returns: .

GetTextLength()

Returns: .

GetWindowColor(colorIndex)

Returns: .

GetWindowState()

Returns: .

HideSelection(bHide, bPermanent)

Returns: .

HideWindow()

Returns: .

InvalidateWindow()

Returns: .

IsDerivedFromClass(typeClass)

Returns: .

IsEnabled()

Returns: .

IsVisible()

Returns: .

KillTimer(idEvent)

Returns: .

LimitText(nTextLimit)

Returns: .

LineFromChar(nCharIndex)

Returns: .

LineIndex(nLine)

Returns: .

LineLength(nLineIndex)

Returns: .

LineScroll(nLines, nChars)

Returns: .

MoveWindow(xOffset, yOffset)

Returns: .

PixelsToFormUnits(numPixels, vertical)

Returns: .

PostMessage(msg, mywParam, mylParam)

Returns: .

ReplaceSel(sText)

Returns: .

SendMessage(msg, mywParam, mylParam)

Returns: .

SendMessageToChildren(nMsg, nMywParam, nMylParam)

Returns: .

SetContextMenu(sMenuName, nFlags)

Returns: .

SetContextMenu(menuType, flags)

Returns: .

SetCursor(resource, type)

Returns: .

SetCursor(resourceId, type)

Returns: .

SetCursor(blob, type)

Returns: .

SetCursorFile(file, type)

Returns: .

SetDefaultCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Returns: .

SetFocus()

Returns: .

SetFont(name, size, enhancement)

Returns: .

SetLocation(x, y)

Returns: .

SetModify(bState)

Returns: .

SetOptions(nOptions)

Returns: .

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

Returns: .

SetProperty(name, value, length)

Returns: .

SetSel(nStart, nEnd)

Returns: .

SetSelectionCharFormat(sFontName, nPointSize, nEnhFlags, nTextColor)

Returns: .

SetSize(width, height)

Returns: .

SetText(text)

Returns: .

SetTimer(idEvent, elapseMilliSec)

Returns: .

SetWindowColor(colorIndex, color)

Returns: .

ShowWindow()

Returns: .

TrackPopupMenu(menuName, flags, x, y)

Returns: .

TrackPopupMenu(menuType, flags, x, y)

Returns: .

UpdateWindow()

Returns: .

WinHelp(file, command, numData, strData)

Returns: .

Yield()

MessageActions

Message Actions

WindowActions

Window Actions

String
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalString
SalBoolean
SalBoolean
SalBoolean
SalWindowHandle
SalNumber
SalNumber
VisRichEdit
SalString
SalNumber
SalBoolean
SalWindowHandle
SalNumber
SalBoolean
SalNumber
SalString
SalNumber
SalBoolean
SalNumber
SalBoolean
SalString
SalWindowHandle
SalBoolean
SalWindowHandle
SalBoolean
SalString
SalBoolean
SalBoolean
SalNumber
SalString
SalBoolean
SalString
SalNumber
SalString
SalNumber
SalNumber
SalNumber
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalNumber
SalNumber
SalNumber
SalBoolean
SalBoolean
SalNumber
SalBoolean
SalBoolean
SalNumber
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalWindowHandle
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalBoolean
SalMessageHandler
WindowActionsEventHandler
SalNumber
SalString
SalString
SalNumber
SalString
SalNumber
SalBoolean
SalWindowHandle
SalString&
SalNumber&
SalNumber&
SalNumber&
SalNumber
SalString&
SalNumber&
SalNumber&
SalNumber
SalNumber&
SalNumber&
SalString&
SalNumber
SalNumber&
SalNumber&
SalNumber&
SalNumber&
SalNumber&
SalArray`1&
SalNumber&
SalString
SalString&
SalString
SalNumber&
SalNumber&
SalString&
SalNumber&
SalNumber&
SalNumber&
SalNumber&
SalNumber&
SalString&
SalNumber
SalNumber
SalNumber
SalBoolean
SalBoolean
Type
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalBoolean
SalNumber
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalString
SalNumber
Type
SalNumber
SalResourceCursor
SalNumber
Int32
SalNumber
SalString
SalNumber
SalString
SalNumber
SalString
SalNumber
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalNumber
SalNumber
SalBoolean
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalArray<SalNumber>
SalNumber
SalString
SalString
SalNumber
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalNumber
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalNumber
Type
SalNumber
SalNumber
SalNumber
SalString
SalNumber
SalNumber
SalString
ISalWindow
Boolean
SalNamedProperties