GraffitiSuite Docs
Docs
Graffitisimpleeditor
Loading document parsing libraries...
# GraffitiSimpleEditor Class Inherits GraffitiWebUIControl ## About GraffitiSimpleEditor is based on the popular QuillJS JavaScript library for WYSIWYG HTML content generation. It doesn't require you to fight with RTF to get great results. ## Warnings ### HTML Content Support HTML supplied to GraffitiSimpleEditor may not render entirely as expected if it did not originate from GraffitiSimpleEditor. Conversion of this HTML to match the expected formatting is attempted, but may produce unexpected results. Support for these incongruities is not provided. ## Enumerations | Name | Value | Description | | --- | :---: | --- | | Alignments | Left <br> Center <br> Right | | | Headers | HeaderNone <br> Header1 <br> Header2 <br> Header3 <br> Header4 | | | ListTypes | None <br> Checked <br> Ordered <br> Unordered | | | ToolbarItems | SectionFont <br> SectionDecoration <br> SectionColor <br> SectionScript <br> SectionBlock <br> SectionList <br> SectionIndent <br> SectionPosition <br> SectionInsert <br> SectionClean <br> SectionTable <br> SectionCustom <br> MenuFontName <br> MenuFontSize <br> MenuLineHeight <br> MenuColor <br> MenuBackground <br> ButtonBold <br> ButtonItalic <br> ButtonUnderline <br> ButtonStrike <br> ButtonSubscript <br> ButtonSuperscript <br> ButtonHeader1 <br> ButtonHeader2 <br> ButtonQuote <br> ButtonCode <br> ButtonListOrdered <br> ButtonListUnordered <br> ButtonListCheck <br> ButtonIndent <br> ButtonOutdent <br> ButtonDirection <br> ButtonAlignLeft <br> ButtonAlignRight <br> ButtonAlignCenter <br> ButtonHorizontalRule <br> ButtonLink <br> ButtonImage <br> ButtonVideo <br> ButtonClean <br> ButtonCustom <br> ButtonTable <br> ButtonTableRow <br> ButtonTableColumn | | ## Event Definitions | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | ContextClick | X as Integer <br> Y as Integer | (None) | | | EditorDefaults | byRef DefaultFontFace as String <br> byRef DefaultFontSize as Integer <br> byRef allowNesting as Boolean <br> byRef lineHeight as Double | (None) | | | FocusLost | (None) | (None) | | | FocusReceived | (None) | (None) | | | FontsImport | (None) | String | | | FontsInitialize | byRef CurrentFonts() as String <br> allowedLineHeights() as Double | (None) | | | FormatChange | (None) | (None) | | | GetLanguage | (None) | String | | | HashtagAdded | tagID as Integer <br> tagValue as String | (None) | | | KeyPress | keyChar as String <br> AltKey as Boolean <br> CtrlKey as Boolean <br> MetaKey as Boolean <br> ShiftKey as Boolean | (None) | | | LinkPreview | linkURL as String | Boolean | | | MentionAdded | mentionID as Integer <br> mentionValue as String | (None) | | | MenuClear | (None) | Boolean | | | MenuCopy | (None) | Boolean | | | MenuCut | (None) | Boolean | | | MenuPaste | (None) | Boolean | | | MenuRedo | (None) | Boolean | | | MenuSelectAll | (None) | Boolean | | | MenuUndo | (None) | Boolean | | | MouseWheel | X as Integer <br> Y as Integer <br> deltaX as Integer <br> deltaY as Integer | (None) | | | Opening | (None) | (None) | | | SelChange | (None) | (None) | | | TextChanged | (None) | (None) | | | Toolbar_BackgroundClick | (None) | (None) | | | Toolbar_ButtonClick | buttonID as String | (None) | | | Toolbar_ColorClick | (None) | (None) | | | Toolbar_ImageClick | (None) | (None) | | | Toolbar_InsertTableClick | (None) | (None) | | | Toolbar_LinkClick | hasMedia as Boolean = False | (None) | | | Toolbar_VideoClick | (None) | (None) | | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | Sub | AddHashTag | (None) | | | Sub | AddHashTags | (None) | | | Sub | AddMention | (None) | | | Sub | AddMentions | (None) | | | Sub | ClearUndoHistory | (None) | | | Sub | Copy | (None) | | | Function | CurrentLine | As | | | Sub | Cut | (None) | | | Sub | Delete | (None) | | | Function | ExportCSS | As | | | Sub | ForceUpdate | (None) | | | Function | GenerateUUID | As | | | Function | HashTag | As | | | Function | HashTagCount | As | | | Sub | InsertAudio | (None) | | | Sub | InsertDeltas | (None) | | | Sub | InsertFile | (None) | | | Sub | InsertHorizontalRule | (None) | | | Sub | InsertHTML | (None) | | | Sub | InsertImage | (None) | | | Sub | InsertImage | (None) | | | Sub | InsertLineBreak | (None) | | | Sub | InsertLink | (None) | | | Sub | InsertTable | (None) | | | Sub | InsertTableColumn | (None) | | | Sub | InsertTableRow | (None) | | | Sub | InsertVideo | (None) | | | Function | IsURL | As | | | Function | Mention | As | | | Function | MentionCount | As | | | Sub | Paste | (None) | | | Sub | Redo | (None) | | | Sub | RemoveAllHashTags | (None) | | | Sub | RemoveAllMentions | (None) | | | Sub | RemoveHashTag | (None) | | | Sub | RemoveMention | (None) | | | Function | SanitizeFont | As | | | Sub | SelectAll | (None) | | | Sub | ToolbarAddButton | (None) | | | Sub | ToolbarItemVisible | (None) | | | Sub | ToolbarItemVisible_Custom | (None) | | | Sub | ToolbarRemoveButton | (None) | | | Sub | ToolbarTooltip | (None) | | | Function | toPage | As | | | Sub | Undo | (None) | | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | AllowLocalImageDrops | Boolean | False | | | Attributes | SelTextBackground | Nil | | | CalculatedHeight | Integer | Nil | | | CanRedo | Boolean | Nil | | | CanUndo | Boolean | Nil | | | CustomContextMenu | Boolean | Nil | | | EditorMarginBottom | Integer | Nil | | | EditorMarginLeft | Integer | Nil | | | EditorMarginRight | Integer | Nil | | | EditorMarginTop | Integer | Nil | | | Enabled | Boolean | Nil | | | EnforceHTTPS | Boolean | Nil | | | HTML | String | Nil | | | isDirty | Boolean | Nil | | | Length | Integer | Nil | | | PlainText | String | Nil | | | Private | | Double | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | = | | | Private | As | Nil | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | = | | | Private | | String | | | Private | As | = | | | Private | As | = | | | Private | As | Nil | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | = | | | Private | As | = | | | Private | As | = | | | Private | As | Nil | | | Private | As | = | | | Private | As | = | | | Private | As | = | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | = | | | Private | As | = | | | Private | As | = | | | Private | | String | | | Private | As | = | | | Private | As | = | | | Private | As | Nil | | | Private | | ToolbarItems | | | Private | | String | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | Private | As | Nil | | | Private | As | Nil | | | Private | As | = | | | SelAlign | Alignments | Nil | | | SelBold | Boolean | Nil | | | SelFont | String | Nil | | | SelHeader | Headers | Nil | | | SelItalic | Boolean | Nil | | | SelLength | Integer | Nil | | | SelLineHeight | Double | Nil | | | SelLink | Boolean | Nil | | | SelLinkURL | String | Nil | | | SelList | ListTypes | Nil | | | SelPlain | Boolean | Nil | | | SelStart | Integer | Nil | | | SelStrike | Boolean | Nil | | | SelSubscript | Boolean | Nil | | | SelSuperscript | Boolean | Nil | | | SelTable | Boolean | Nil | | | SelText | String | Nil | | | SelTextBackgroundColor | Color | Nil | | | SelTextColor | Color | Nil | | | SelTextSize | Integer | Nil | | | SelUnderline | Boolean | Nil | | | SpellCheck | Boolean | Nil | | | ToolbarVisible | Boolean | Nil | | | WordWrap | Boolean | Nil | |