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 | (None) | | Headers | HeaderNone <br > Header1 <br > Header2 <br > Header3 <br > Header4 | (None) | | ListTypes | None <br > Checked <br > Ordered <br > Unordered | (None) | | 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 > 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 | (None) | ## Event Definitions | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | ContextClick | X as Integer <br> Y as Integer | (None) | (None) | | EditorDefaults | byRef DefaultFontFace as String <br> byRef DefaultFontSize as Integer | (None) | (None) | | GotFocus | (None) | (None) | (None) | | HashtagAdded | tagID as Integer <br> tagValue as String | (None) | (None) | | LocalFileSelected | localFileName as String <br> localFileURL as String | (None) | (None) | | LostFocus | (None) | (None) | (None) | | MentionAdded | mention as GraffitiSimpleEditorMention | (None) | (None) | | Open | (None) | (None) | (None) | | SelChange | (None) | (None) | (None) | | Shown | (None) | (None) | (None) | | TextChanged | (None) | (None) | (None) | | Toolbar_BackgroundClick | (None) | (None) | (None) | | Toolbar_ButtonClick | buttonID as String | (None) | (None) | | Toolbar_ColorClick | (None) | (None) | (None) | | Toolbar_InsertTableClick | (None) | (None) | (None) | ## Methods | Name | Parameters | Return Type | Description | | --- | :---: | :---: | --- | | AddFont | FontName as String | (None) | (None) | | AddHashTag | HashValue as String | (None) | (None) | | AddHashTags | Values() as String | (None) | (None) | | AddMention | mention as GraffitiSimpleEditorMention | (None) | Adds the specified mention object. | | AddMention | MentionValue as String | (None) | (None) | | AddMentions | mentions() as GraffitiSimpleEditorMention | (None) | (None) | | AddMentions | Values() as String | (None) | (None) | | BindImageUpload | theControl as WebControl | (None) | (None) | | ClearUndoHistory | (None) | (None) | (None) | | CurrentLine | (None) | Integer | (None) | | Delete | (None) | (None) | (None) | | ExportCSS | (None) | String | (None) | | HashTag | tagID as Integer | String | (None) | | HashTagCount | (None) | Integer | (None) | | InsertAudio | SourceURL as String | (None) | (None) | | InsertDeltas | theDelta as JSONItem | (None) | (None) | | InsertFile | theFile as FolderItem <br> atPos as Integer = 0 | (None) | (None) | | InsertHorizontalRule | (None) | (None) | (None) | | InsertHTML | htmlString as String | (None) | (None) | | InsertImage | f as FolderItem <br> altText as String = "" <br> atPos as Integer = 0 <br> imageWidth as Integer = -1 <br> imageHeight as Integer = -1 | (None) | (None) | | InsertImage | URL as String <br> altText as String = "" <br> atPos as Integer = 0 <br> imageWidth as Integer = -1 <br> imageHeight as Integer = -1 | (None) | (None) | | InsertLink | URL as String <br> Title as String = "" <br> atPos as Integer = 0 <br> atLength as Integer = 0 | (None) | (None) | | InsertTable | Rows as Integer <br> Columns as Integer | (None) | (None) | | InsertTableColumn | (None) | (None) | (None) | | InsertTableRow | Above as Boolean = False | (None) | (None) | | InsertVideo | URL as String | (None) | (None) | | MentionAt | index as Integer | GraffitiSimpleEditorMention | (None) | | MentionFromName | displayName as String | GraffitiSimpleEditorMention | (None) | | MentionFromTag | tag as Variant | GraffitiSimpleEditorMention | (None) | | MentionLastIndex | (None) | Integer | (None) | | Redo | (None) | (None) | (None) | | RemoveAllHashTags | (None) | (None) | (None) | | RemoveAllMentions | (None) | (None) | Removes all mentions. | | RemoveHashTag | tagID as Integer | (None) | (None) | | RemoveMention | mention as GraffitiSimpleEditorMention | (None) | Removes the specified mention. | | sanitizeCSSClass | rawString As String | String | (None) | | SelectAll | (None) | (None) | (None) | | ToolbarAddButton | ButtonID as String <br> ButtonCaption as String <br> ButtonTooltip as String = "" <br> toGroupName as String = "" | (None) | (None) | | ToolbarAddGroup | name as String | (None) | (None) | | ToolbarItemVisible | ParamArray theItem as ToolbarItems <br> assigns value as Boolean | (None) | (None) | | ToolbarItemVisible_Custom | CustomID as String <br> Value as Boolean | (None) | (None) | | ToolbarRemoveButton | ButtonID as String | (None) | (None) | | ToolbarRemoveGroup | name as String | (None) | (None) | | ToolbarTooltip | theItem as ToolbarItems <br> theTooltip as String <br> CustomButtonID as String = "" | (None) | (None) | | toPage | PageTitle as String <br> includeStyleBlock as Boolean = False <br> additionalCSS as String = "" | String | (None) | | Undo | (None) | (None) | (None) | ## Properties | Name | Type | Default Value | Description | | --- | :---: | :---: | --- | | CanRedo | Boolean | (None) | (None) | | CanUndo | Boolean | (None) | (None) | | DarkMode | Boolean | (None) | (None) | | EditorBackground | Color | (None) | (None) | | EditorMarginBottom | Integer | (None) | (None) | | EditorMarginLeft | Integer | (None) | (None) | | EditorMarginRight | Integer | (None) | (None) | | EditorMarginTop | Integer | (None) | (None) | | Enabled | Boolean | (None) | (None) | | HTML | String | (None) | (None) | | Length | Integer | (None) | (None) | | PlainText | String | (None) | (None) | | SelAlign | Alignments | (None) | (None) | | SelBold | Boolean | (None) | (None) | | SelHeader | Headers | (None) | (None) | | SelItalic | Boolean | (None) | (None) | | SelLength | Integer | (None) | (None) | | SelList | ListTypes | (None) | (None) | | SelPlain | Boolean | (None) | (None) | | SelStart | Integer | (None) | (None) | | SelStrike | Boolean | (None) | (None) | | SelSubscript | Boolean | (None) | (None) | | SelSuperscript | Boolean | (None) | (None) | | SelText | String | (None) | (None) | | SelTextBackgroundColor | Color | (None) | (None) | | SelTextColor | Color | (None) | (None) | | SelTextSize | Integer | (None) | (None) | | SelUnderline | Boolean | (None) | (None) | | SpellCheck | Boolean | (None) | (None) | | ToolbarBackground | Color | (None) | (None) | | ToolbarVisible | Boolean | (None) | (None) | | WordWrap | Boolean | (None) | (None) |