Table of Contents
Preview #
About #
GraffitiDiffViewer is a simple component that allows the visualization of changed lines between two source texts.
Requirements #
- This class requires a DesktopHTMLViewer be present on a view (DesktopWindow or DesktopContainer) in your project for Windows support.
- Due to issues with Xojo’s implementation or platform limitations, this control may not function on Linux targets or require additional setup on target machines.
Enumerations #
| Name | Values |
|---|---|
| ViewTypes | SideBySide Inline |
Constants #
This class exposes no constants.
Events #
This class exposes no events.
Methods #
| Name | Parameters | Return Type | Description |
|---|---|---|---|
| ToHTML | includeCSS as Boolean = True | String | Returns an HTML string of the rendered output. Required Bootstrap 5.x also be loaded in the target document. |
Properties #
| Name | Type | Default Value | Description |
|---|---|---|---|
| ContextSize | Integer | 0 | The number of lines around a changed line that are shown for context. |
| ShowAttribution | Boolean | True | Controls the display as the attribution footer to the Open Source library upon which GraffitiDiffViewer is built. The library is BSD licensed, so you should familiarize yourself with the requirements of the license before disabling the attribution. |
| TextBase | String | “” | Base text to compare against. |
| TextCompare | String | “” | Changed text compare against TextBase. |
| TitleBase | String | “Base Text” | Text describing TextBase to the user. |
| TitleCompare | String | “Modified Text” | Text describing TextCompare to the user. |
| ViewType | GraffitiDiffViewer.ViewTypes | GraffitiDiffViewer.ViewTypes.SideBySide | Determines how changes are presented to the user. |