Description
Inserts a rich text format or plain text file into a DataWindow control or DataStore object.
The new content is added in one of two ways:
-
The new content can be inserted at the insertion point.
-
The new content can replace all existing content.
Applies to
Syntax
PowerBuilder
integer dwcontrol.InsertDocument ( string filename, boolean clearflag, FileType filetype)
|
Argument |
Description |
|---|---|
|
dwcontrol |
A reference to a DataWindow control or DataStore object. The DataWindow object in the DataWindow control or DataStore must be a RichTextEdit DataWindow. |
|
filename |
A string whose value is the name of the file you want to display in the RichTextEdit control. Filename can include the file's path. |
|
clearflag |
A boolean value specifying whether the new file will replace the current contents of the control. Values are:
|
|
filetype |
A value of the FileType enumerated datatype specifying the type of file being opened. Values are:
|
Return value
Returns 1 if it succeeds and -1 if an error occurs. If any argument's value is null, InsertDocument returns null.
Usage
When the control supports headers and footer (the HeaderFooter property is set to true), inserting a document can replace, but not add to, existing header and footer text. You must set clearflag to true to replace the existing header and footer text with header and footer text from the inserted document.
Not all RTF formatting is supported. PowerBuilder supports version 1.6 of the RTF standard, except for the following:
-
No support for formatted tables
-
No drawing controls
Any unsupported formatting is ignored.
PowerBuilder environment
For use with other PowerBuilder RichTextEdit controls, see the section called “InsertDocument” in PowerScript Reference.
Examples
This example inserts a document into a RichTextEdit DataWindow:
integer rtn
rtn = dw_1.InsertDocument("c:\pb\test.rtf", &
false, FileTypeRichText!)See also
DataSource in the section called “DataSource” in PowerScript Reference
InputFieldInsert in the section called “InputFieldInsert” in PowerScript Reference
InsertPicture in the section called “InsertPicture” in PowerScript Reference
