|Navigation: Templates > Guide to all Templates > Additional Libraries and Templates > Rich Text Template Support - Overview >====== IsDirtyRTF code template ======|
This template (and its associated code templates) has been deprecated, and is now replaced by the RTF Text Control template.
The IsDirtyRTF code template is used to determine if the text in the RTF control has changed. If the text has changed, the user can be prompted to save all changes. This template calls the IsDirty method. Theparameter passed to the method determines whether the user will be prompted to save changes. A TRUE value indicates the user will be prompted. A FALSE value indicates the user will not be prompted.
IsDirty( PromptToSave )
Return Data Type: BYTE
Example method calls:
loc:dirty = oRTF_RTFTextBox.IsDirty( 1 ) !Prompt to save changes
loc:dirty = oRTF_RTFTextBox.IsDirty( 0 ) !No prompt to save changes
Associated RTF control
Select the RTF control from the drop-down list. All controls on the Window are included in the list. This field in required.
Variable to receive document status
Press the ellipsis button (') to choose a variable to receive the return value from the method.
Prompt to save if modified
Check this box to prompt the user to save changes to the rich text field if the field has changed.