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. ## 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) | | | FontsImport | (None) | String | | | FontsInitialize | byRef CurrentFonts() as String <br> allowedLineHeights() as Double | (None) | | | FormatChange | (None) | (None) | | | GetLanguage | (None) | String | | | GotFocus | (None) | (None) | | | 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 | | | LostFocus | (None) | (None) | | | 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 | | --- | :---: | :---: | --- | | AddHashTag | HashValue as String | (None) | | | AddHashTags | Values() as String | (None) | | | AddMention | MentionValue as String | (None) | | | AddMentions | Values() as String | (None) | | | ClearUndoHistory | (None) | (None) | | | Copy | (None) | (None) | | | CurrentLine | (None) | Integer | | | Cut | (None) | (None) | | | Delete | (None) | (None) | | | ExportCSS | (None) | String | | | ForceUpdate | (None) | (None) | | | GenerateUUID | (None) | String | | | HashTag | tagID as Integer | String | | | HashTagCount | (None) | Integer | | | InsertAudio | SourceURL as String | (None) | | | InsertDeltas | theDelta as JSONItem | (None) | | | InsertFile | theFile as FolderItem <br> atPos as Integer = 0 | (None) | | | InsertHorizontalRule | (None) | (None) | | | InsertHTML | htmlString as String | (None) | | | InsertImage | f as FolderItem <br> altText as String = "" <br> atPos as Integer = 0 <br> imageWidth as Integer = -1 <br> imageHeight as Integer = -1 <br> hasAlt as Boolean = False | (None) | | | InsertImage | URL as String <br> altText as String = "" <br> atPos as Integer = 0 <br> imageWidth as Integer = -1 <br> imageHeight as Integer = -1 <br> hasAlt as Boolean = False | (None) | | | InsertLineBreak | (None) | (None) | | | InsertLink | URL as String <br> Title as String = "" <br> atPos as Integer = 0 <br> atLength as Integer = 0 | (None) | | | InsertTable | Rows as Integer <br> Columns as Integer | (None) | | | InsertTableColumn | (None) | (None) | | | InsertTableRow | (None) | (None) | | | InsertVideo | URL as String | (None) | | | Mention | mentionID as Integer | String | | | MentionCount | (None) | Integer | | | Paste | (None) | (None) | | | Redo | (None) | (None) | | | RemoveAllHashTags | (None) | (None) | | | RemoveAllMentions | (None) | (None) | | | RemoveHashTag | tagID as Integer | (None) | | | RemoveMention | mentionID as Integer | (None) | | | SanitizeFont | FontName as String | String | | | SelectAll | (None) | (None) | | | ToolbarAddButton | ButtonID as String <br> ButtonCaption as String <br> ButtonTooltip as String = "" | (None) | | | ToolbarItemVisible | ParamArray theItem as ToolbarItems <br> assigns value as Boolean | (None) | | | ToolbarItemVisible_Custom | CustomID as String <br> Value as Boolean | (None) | | | ToolbarRemoveButton | ButtonID as String | (None) | | | ToolbarTooltip | theItem as ToolbarItems <br> theTooltip as String <br> CustomButtonID as String = "" | (None) | | | toPage | PageTitle as String <br> includeStyleBlock as Boolean = False <br> additionalCSS as String = "" | String | | | Undo | (None) | (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 | | | SelAlign | GraffitiSimpleEditor.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 | |