Rich text and the end user

All the editing tools described throughout this chapter and in the chapter on working with rich text in the PowerBuilder Users Guide can be made available to your users.

What users can do

Users can:

What you can make available to users in your code

You can program an application to allow users to:

If a RichTextEdit control shares data with a DataWindow object or DataStore, you can program:

The best way for you to prepare rich text for use in your application is to become a user yourself and edit the text in an application designed for the purpose. During execution, all the tools for text preparation are available.

What the user sees

The default view is the body text. You can also show header and footer text and a print preview. To show header and footer text, you must select the HeaderFooter property in the rich text control's Properties view at design time. This value cannot be changed during execution, although if you select it at design time, you can programmatically show the header and footer text at runtime.

Header and footer text For either a RichText DataWindow object or the RichTextEdit control, you can call the ShowHeadFoot function in a menu or button script. To display the header editing panel, you can call:

dw_1.ShowHeadFoot(TRUE)

To display the footer editing panel, you must call:

dw_1.ShowHeadFoot(TRUE, FALSE)

NoteInserting the current page number in a footer The following script inserts the current page number in the footer, then returns the focus to the body of the document in the rich text control. The PAGENO field name that you insert must be entered in capital letters only:

rte_1.ShowHeadFoot(true,false)
rte_1.SetAlignment ( Center! )
rte_1.InputFieldInsert("PAGENO")
rte_1.ShowHeadFoot(false,false)

You cannot change the PAGENO field with an InputFieldChangeData call.

In the overloaded function ShowHeadFoot, the second argument defaults to TRUE if a value is not provided. Call the function again to return to normal view.

dw_1.ShowHeadFoot(FALSE)

The document as it would be printed The user can press ctrl+f2 to switch print preview mode on and off. You can also control print preview mode programmatically.

For a RichTextEdit control, call the Preview function:

rte_1.Preview(TRUE)

For a RichText DataWindow object, set the Preview property:

dw_1.Object.DataWindow.Print.Preview = TRUE

Text elements and formatting

The user can specify formatting for:

StepsTo display the property sheet for an object, the user can:

  1. Select the object. For example:

    • Drag or use editing keys to select text

    • Click on a picture

    • Set an insertion point (nothing selected) for the rich text document

  2. Right-click in the workspace and select Properties from the pop-up menu.

StepsTo make settings for the paragraphs in the selection:

  1. Double-click on the ruler bar

    or

    Type Ctrl+Shift+S.

Modifying input fields

Unless you have made the rich text object display only, the user can modify the values of input fields.

StepsTo modify the value of an input field:

  1. Click the input field to select it.

  2. Right-click in the workspace and choose Properties from the pop-up menu.

    The Input Field Object property sheet displays.

  3. On the Input Field page, edit the Data Value text box.

Text formatting for input fields There are several ways to select the input field and apply text formatting. When the input field is selected, the Font page of the property sheet and the toolbar affect the text. When the input field is part of a text selection, changes affect all the text, including the input field.

The user cannot apply formatting to individual characters or words within the field. When the user selects the input field, the entire field is selected.

Inserting and deleting input fields You write scripts that let the user insert and delete input fields. The user can also copy and paste existing input fields. All copies of an input field display the same data.

Formatting keys and toolbars

When the toolbar is visible, users can use its buttons to format text, or they can use designated keystrokes to format text in the RichTextEdit control.

For a list of keystrokes for formatting rich text, see the chapter on working with rich text in the PowerBuilder Users Guide.