RichText.property – PB Docs 2021

property

A property for the DataWindow RichText presentation
style. Properties and appropriate values are listed in the table
below.

value

A value to be assigned to the
property.

BackColor

A long specifying the numeric value of the
background color of the text editing area. Values are -2 to
16,777,215.

For more information about color, see
RGB.

Painter: Background
Color group, General option.

ControlCharsVisible

Specifies whether control characters (carriage
returns, spaces, and tabs) are visible. Values
are:

Painter: RichText Presentation group,
ControlChars Visible option.

DisplayOnly

Specifies whether users can make changes to the
contents. Values are:

Painter: Display Only
option.

HeaderFooter

(Read-only) Specifies whether the RichTextEdit
DataWindow has a header/footer section. This property must be
set in the painter and cannot be changed at runtime. Values
are:

If a document has a header or footer and
the HeaderFooter property is set to no, then header/footer
information in the document is ignored. If the document is then
saved in the same file, the header/footer information is
lost.

Painter: Header/Footer option.

InputField BackColor

A long specifying the default background color for
all input fields: -2 to 16,777,215.

Painter:
Background Color group, Input Field option.

InputField NamesVisible

Specifies whether input field names are displayed
in input fields, rather than the input field values. Values
are:

The value you specify is ignored when the
InputFieldsVisible property is set to
false.

Painter: RichText Presentation group, Input
Field Names Visible option.

InputFields Visible

Specifies whether input fields display in the
DataWindow object. Values are:

Painter: RichText Presentation group,
Input Fields Visible option.

PictureFrame (obsolete)

(Obsolete) This property is no longer supported
since PowerBuilder 12.6.

Specifies whether pictures
are displayed as empty frames. Values are:

Painter: Pictures As Frame
option.

PopMenu

Specifies whether the user has access to a pop-up
menu by clicking the right mouse button on the DataWindow. The
menu allows the user to cut and paste, insert a file, and select
formatting options. Values are:

Painter: PopUp Menu
option.

ReadOnly

Specifies whether the user can change the data and
the text in the DataWindow. Values are:

ReturnsVisible (obsolete)

Replaced by RichText.ControlCharsVisible
property.

RulerBar

Specifies whether a ruler bar is visible above the
editing area. If visible, the user can use it to see
measurements while setting tabs and margins on the tab bar (see
the TabBar property in this table). Values
are:

If the RichTextEdit pop-up menu is
enabled, the user can use it to turn ruler bar display on and
off (see the PopMenu property in this
table).

Painter: RichText Bars group, Ruler
option.

SpacesVisible

Specifies whether spaces are visible. Values
are:

Painter: RichText Presentation group,
Spaces Visible option.

TabBar (obsolete)

(Obsolete) This property is no longer supported
since PowerBuilder 12.6.

Specifies whether a bar for
setting tabs is visible above the editing area. Values
are:

If the pop-up menu is enabled, the user
can use it to turn tab bar display on and off (see the PopMenu
property in this table).

Painter: RichText Bars
group, Tab option.

TabsVisible

Specifies whether tabs are visible. Values
are:

Painter: RichText Presentation group,
Tabs Visible option.

ToolBar

Specifies whether a tool bar for formatting text is
visible above the editing area. Values are:

If the pop-up menu is enabled, the user
can use it to turn tool bar display on and off (see the PopMenu
property in this table).

Painter: RichText Bars
group, Tool option.

WordWrap

Determines whether large blocks of text that do not
contain spaces wrap automatically to the next line when the line
reaches the margin. Values are:

Painter: Word Wrap option