Table of Contents
Version: 2023r1
Properties #
| AlignmentColor as Color | AlignmentsVisible as Boolean | AlignmentThickness as Integer | Background as Picture |
| BackgroundFillColor as Color | Buffer as Picture (Internal) | CanvasObjects() as CanvasObject | EmbeddedContainers() as DesktopContainer (Internal) |
| EmbeddedControls() as DesktopUIControls (Internal) | FigBGToCanvas as Boolean | GridCubeColor as Color | GridSegmentColor as Color |
| GridSegmentModularity as Integer | GridSize as Integer | GridVisible as Boolean | HandleFillColor as Color |
| HandleImage as Picture | HandleOutlineColor as Color | HandlesVisible as Boolean | HoverObject as CanvasObject |
| LastRemoved as CanvasObject | LinkChains() as LinkChain | LockImage as Picture | ObjectCount as Integer |
| ObjectOutlineColor as Color | OutlineInvisible as Boolean | Properties as Dictionary | ResizeColor as Color |
| ResizeGB as Picture | RoundedOutline as Boolean | RoundedOutlineArc as Integer | SelectedHandle as Integer |
| SelectedIndex as Integer | SelectedObject as CanvasObject | ShowLinkChains as Boolean | ShowLock as Boolean |
| SnapToAlign as Boolean | SnapToAlignSensitivity as Integer | UseDefaultCursors as Boolean | X / Y as Integer |
Methods #
| AddDrawableObject(Left as Integer, Top as Integer, Width as Integer, Height as Integer) | AddObject(Left as Integer, Top as Integer, Image As Picture, Optional caption As String = “”, Optional Font as String = “System”, Optional TextSize as Integer = 12, Optional TextColor as Color = &c000000) |
| AddOval(Left as Integer, Top as Integer, Width as Integer, Height as Integer, Optional PenHeight as Integer = 1, Optional PenColor as Color = &c000000) | AddQuadrilateral(Left as Integer, Top as Integer, Width as Integer, Height as Integer, BorderWidth as Integer = 0, Optional PenHeight as Integer = 1, Optional PenColor as Color = &c000000) |
| AddStyledTextObject(sText as StyledText, Left as Integer, Top as Integer, Width as Integer, Height as Integer) | ClearCanvas() |
| Constructor() | DeleteAllCanvasObjects() |
| DeselectAll() | DisableDesignerMode() |
| EmbedContainer(ctlContainer as DesktopContainer, Top as Integer, Left as Integer, Optional Width as Integer, Optional Height as Integer) | EmbedContainerInCanvasObject(co as CanvasObject, ctlContainer as DesktopContainer, Top as Integer, Left as Integer, Optional Width as Integer, Optional Height as Integer) |
| EmbedControl(ctlControl as DesktopUIControl, Top as Integer, Left as Integer, Optional Width as Integer, Optional Height as Integer) | EmbedControlInCanvasObject(co as CanvasObject, ctlControl as DesktopUIControl, Top as Integer, Left as Integer, Optional Width as Integer, Optional Height as Integer) |
| ExportBMP(FileName as FolderItem) as Boolean | ExportGIF(FileName as FolderItem) as Boolean |
| ExportPNG(FileName as FolderItem, RetainTransparencies as Boolean) as Boolean) | ExportTIFF(FileName as FolderItem) as Boolean |
| FlattenedImage(RetainTransparencies as Boolean) as Picture | GetDesignerHTML(HTMLTitle as String) as String |
| GetDesignerXML() as String | IndexByName(Name as String) as Integer |
| InnerControlBottom(cObject as CanvasObject) as Integer | InnerControlLeft(cObject as CanvasObject) as Integer |
| InnerControlRight(cObject as CanvasObject) as Integer | InnerControlTop(cObject as CanvasObject) as Integer |
| LinkChain(co1 as CanvasObject, LinkPoint1 as Integer, co2 as CanvasObject, LinkPoint2 as Integer, LineThickness as Integer, LineColor as Color, Optional Arrow1 as Boolean = False, Optional Arrow2 as Boolean = False) | LinkChainPointX(co as CanvasObject, LinkPoint as Integer) as Integer |
| LinkChainPointY(co as CanvasObject, LinkPoint as Integer) as Integer | LoadDesignerXML(FileName as FolderItem) |
| LoadDesignerXMLFromString(DesignerXML as String) | LockObject(co as CanvasObject) |
| MoveBackward(co As CanvasObject) | MoveForward(co As CanvasObject) |
| MoveObject(co As CanvasObject, Left As Integer, Top As Integer) MoveObject(index As Integer, Left As Integer, Top As Integer) | MoveToBack(co As CanvasObject) |
| MoveToFront(co As CanvasObject) | ObjectFlipHorizontally() |
| ObjectFlipVertically() | ObjectRotate180() |
| ObjectRotate270() | ObjectRotate90() |
| PictureToHTMLDataURI(MyPic As Picture) as String | Redraw(Optional ForceUpdateNow as Boolean = False) |
| RemoveObject(co as CanvasObject) RemoveObject(index as Integer) | ResizeObject(co As CanvasObject, Width as Integer, Height as Integer) |
| SaveDesignerXML(FileName as FolderItem) | SelectObject(index as Integer) |
| UnChain(co1 as CanvasObject) UnChain(co1 as CanvasObject, co2 as CanvasObject) UnChain(co1 as CanvasObject, LinkPoint1 as Integer, co2 as CanvasObject, LinkPoint2 as Integer) | UndoRemoveLastObject() |
| UnlockObject(co as CanvasObject) | UpdateObject(Pic As Picture, m as CanvasObject) |
Events #
**Supports all standard Xojo DesktopCanvas events, plus the following additions/modifications:
| DeSelectedAll() | LoadedXML() | MouseDown(cObj as CanvasObject, X as Integer, Y as Integer) |
| MouseDrag(cObj as CanvasObject, X as Integer, Y as Integer) | MouseUp(cObj as CanvasObject, X as Integer, Y as Integer) | NoObjectHasFocus() |
| ObjectCreated(co as CanvasObject) | ObjectMouseEnter(HoverObject as CanvasObject, CanvasObjectIDX as Integer) | ObjectMouseExit(HoverObject as CanvasObject) |
| ObjectMoved(co As CanvasObject) | ObjectRemoved(co as CanvasObject) | ObjectResized(co As CanvasObject) |
| ObjectResizing(co as CanvasObject, Left as Integer, Top as Integer, Width as Integer, Height as Integer) | ObjectSelected(co As CanvasObject) | ObjectUndoRemove(co as CanvasObject) |
| Opening() | PaintToBack(g as Graphics, areas() as Xojo.Rect) | PaintToFront(g as Graphics, areas() as Xojo.Rect) |
Included Module Extensions #
See Also #
CanvasObject, XDSLinkChain