RichText.property

Description

Properties for the DataWindow RichText presentation style.

Applies to

DataWindows

Syntax

PowerBuilder dot notation:

dw_control.Object.DataWindow.RichText.property

Describe and Modify argument:

"DataWindow.RichText.property { = value }"

Parameter	Description
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.

Property for RichText	Value
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: Yes – Control characters are visible. No – Control characters are hidden. Painter: RichText Presentation group, ControlChars Visible option.
DisplayOnly	Specifies whether users can make changes to the contents. Values are: Yes – The content, including text and input files, is protected (the user cannot edit it). No – The user can edit the content. 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: Yes – The control has a header/footer section. No – The control does not have a header/footer section. 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: Yes – Input fields display. No – Input fields do not display. 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: Yes – Input fields display their names. No – Input fields display their data. Painter: RichText Presentation group, Input Fields Visible option.
PictureFrame	Specifies whether pictures are displayed as empty frames. Values are: Yes – Pictures are displayed as empty frames. No – The pictures are displayed. 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: Yes – Pop-up menu is enabled. No – Pop-up menu is disabled. Painter: PopUp Menu option.
ReadOnly	Specifies whether the user can change the data and the text in the DataWindow. Values are: Yes – The DataWindow is read-only (text and data cannot be modified). No – The text and the data can be modified.
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: Yes – Ruler bar is visible. No – Ruler bar is hidden. 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: Yes – Spaces are visible. No – Spaces are hidden. Painter: RichText Presentation group, Spaces Visible option.
TabBar	Specifies whether a bar for setting tabs is visible above the editing area. Values are: Yes – Tab bar is visible. No – Tab bar is hidden. 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: Yes – Spaces are visible. No – Spaces are hidden. Painter: RichText Presentation group, Tabs Visible option.
ToolBar	Specifies whether a tool bar for formatting text is visible above the editing area. Values are: Yes – Tool bar is visible. No – Tool bar is not visible. 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: Yes – Automatic word wrap is enabled. No – Automatic word wrap is disabled. Users cannot enter characters beyond the right margin, and must move the cursor to a new line to continue entering text. If an inserted document conatins a block of text too large to fit on a line, the nonfitting characters are hidden. Painter: Word Wrap option

Usage

In the painter

Select the DataWindow by deselecting all controls; then set the value in the Properties view, General tab, when the presentation style is RichText.

Examples

Example 1

string setting

setting = &

	dw1.Object.DataWindow.RichText.DisplayOnly

dw1.Object.DataWindow.RichText.PopMenu = "yes"

Example 2

setting = &

	dw1.Describe("DataWindow.RichText.DisplayOnly")

dw1.Modify("DataWindow.RichText.PopMenu = 'yes'")