menu

WinForms

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class RichTextTool - WindowsForms API Reference | Syncfusion

    Show / Hide Table of Contents

    Class RichTextTool

    The rich text tool is used for drawing graphical representation object of an interactive tool for inserting and editing rich text shape in Diagram control.

    Inheritance
    System.Object
    Tool
    UITool
    RectangleToolBase
    RichTextTool
    Implements
    System.IDisposable
    Inherited Members
    RectangleToolBase.Draw(Graphics)
    RectangleToolBase.ProcessMouseDown(MouseEventArgs)
    RectangleToolBase.ProcessMouseMove(MouseEventArgs)
    RectangleToolBase.ProcessMouseUp(MouseEventArgs)
    RectangleToolBase.RenderingHelper
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Tool.Abort()
    Tool.ActionCursor
    Tool.ActivateTool()
    Tool.AppendParentTransformations(PointF, Node)
    Tool.ApplyDecorator(Decorator, Decorator)
    Tool.CanAddNode(Rectangle)
    Tool.CanInsert(Node)
    Tool.CanRender
    Tool.CheckBoundaryConstraints(Node, Matrix)
    Tool.CheckConnectionCenterPort(PointF)
    Tool.CheckConnectionPossibility(PointF)
    Tool.Controller
    Tool.CurrentCursor
    Tool.CurrentPoint
    Tool.CurrentToolCursor
    Tool.DeactivateTool()
    Tool.DrawFrameAroundPort(Graphics, ConnectionPoint)
    Tool.DrawRenderHelper(Node, Graphics)
    Tool.DrawRenderHelper(Node, Graphics, Rectangle)
    Tool.GetCurrentPoint(Boolean)
    Tool.GetEndPointLocation(ConnectionPoint, PointF)
    Tool.GetFrameRectangle(Boolean)
    Tool.GetFullRotationAngle(Node)
    Tool.GetInsideNodeAt(PointF)
    Tool.GetLocalPoint(Node, PointF)
    Tool.GetNodeUnderEndPoint(PointF)
    Tool.GetOriginOffset()
    Tool.GetPointOffset(PointF, Node)
    Tool.GetPortBounds(ConnectionPoint, Single)
    Tool.GetSelectionList()
    Tool.GetSnapCurrentPoint()
    Tool.GetSnapStartPoint()
    Tool.GetStartPoint(Boolean)
    Tool.HighlightCenterPortContainer(Graphics, ConnectionPoint)
    Tool.InAction
    Tool.m_ConnectorSourceEventArgs
    Tool.m_ConnectorTargetEventArgs
    Tool.m_ptStartOrigin
    Tool.m_rulerDisplayRect
    Tool.m_toolPreceding
    Tool.MakeControlNodeSnapshot(ControlNode)
    Tool.Name
    Tool.OnConnectorChanging(EndPointChangingEventArgs)
    Tool.OnOriginChanged(ViewOriginEventArgs)
    Tool.OutlineConnectionPoint(Graphics, ConnectionPoint)
    Tool.PrecedingTool
    Tool.ProcessClick()
    Tool.ProcessDoubleClick(MouseEventArgs)
    Tool.ProcessKeyDown(KeyEventArgs)
    Tool.ProcessKeyPress(KeyPressEventArgs)
    Tool.ProcessKeyUp(KeyEventArgs)
    Tool.QuiteBoundarySet(Boolean)
    Tool.QuiteBridgingSet(Boolean)
    Tool.RulerHeight
    Tool.SingleActionTool
    Tool.SmartSnap(PointF, SizeF)
    Tool.SnapToPort(PointF, SizeF)
    Tool.SnapToPort(PointF, SizeF, Node)
    Tool.StartPoint
    Tool.ToolCursor
    Tool.ToolWorkRect
    Tool.UpdateConnnectorChangeEvent(IEndPointContainer, ConnectionPoint, ConnectionPoint)
    Tool.UpdateCursor(Boolean)
    Tool.UpdatePortRefreshRect(ConnectionPoint, Rectangle)
    Tool.WorkRect
    Tool.WorkRectPrev
    UITool.CanActivateControlPointMoveTools(PointF)
    UITool.CanActivateEndPointMoveTools(PointF)
    UITool.CanActivateLineSegmentTool(PathNode, PointF)
    UITool.CanActivateMoveTool(PointF)
    UITool.CanActivatePinMoveTool(Point)
    UITool.CanActivatePinMoveTool(PointF)
    UITool.CanActivateResizeTool(Point)
    UITool.CanActivateResizeTool(PointF)
    UITool.CanActivateRotateTool(Point)
    UITool.CanActivateRotateTool(PointF)
    UITool.CanActivateSegmentRelatingTools(Point)
    UITool.CanActivateSegmentRelatingTools(PointF)
    UITool.CanActivateVertexDeleteCommand(PathNode)
    UITool.CanActivateVertexInsertCommand(PathNode, PointF)
    UITool.CanActivateVertexMoveTool(PathNode, PointF)
    UITool.CanActivateVertexRelatingTools(Point)
    UITool.CanActivateVertexRelatingTools(PointF)
    UITool.Check(Point)
    UITool.Check(PointF)
    UITool.Dispose()
    UITool.GetCursor(BoxPosition, Node)
    UITool.IsVertexEditMode(Node)
    UITool.PerformHandleMove(MouseEventArgs)
    UITool.PerformLineSegmentMove(MouseEventArgs)
    UITool.PerformMove(MouseEventArgs)
    UITool.PerformPinMove(MouseEventArgs)
    UITool.PerformResize(MouseEventArgs)
    UITool.PerformRotate(MouseEventArgs)
    UITool.PerformVertexMove(MouseEventArgs)
    UITool.ToolToActivate
    Namespace: Syncfusion.Windows.Forms.Diagram
    Assembly: Syncfusion.Diagram.Windows.dll
    Syntax
    public class RichTextTool : RectangleToolBase, IDisposable
    Remarks

    This tool manages the insertion of new rich text nodes into a diagram and editing of existing rich text nodes. Activating this tool causes it to track mouse down, mouse move, and mouse up events and draw a tracking rectangle. The rectangle drawn is used as the bounds of a new rich text node, which is inserted into the diagram using an InsertNodesCmd.

    This tool also listens for double-click events. If the user double clicks on a rich text node, this tool opens a text editor allowing the user to edit the text.

    Tool RectangleToolBase RichTextNode

    Constructors

    RichTextTool(DiagramController)

    Initializes a new instance of the RichTextTool class.

    Declaration
    public RichTextTool(DiagramController controller)
    Parameters
    Type Name Description
    DiagramController controller

    The controller.

    Properties

    DefaultText

    Gets or sets default text value assigned to new text nodes created by this tool.

    Declaration
    public string DefaultText { get; set; }
    Property Value
    Type
    System.String

    Methods

    ActionComplete(Node)

    Method used to perform additional actions after node is inserted into document ( start TextEditor after Text node is inserted into document for example )

    Declaration
    protected override void ActionComplete(Node nodeInserted)
    Parameters
    Type Name Description
    Node nodeInserted

    node inserted into document

    Overrides
    RectangleToolBase.ActionComplete(Node)

    CreateNode(RectangleF)

    Creates the node from given rectangle base.

    Declaration
    protected override Node CreateNode(RectangleF rectBounding)
    Parameters
    Type Name Description
    System.Drawing.RectangleF rectBounding

    The bounding rectangle.

    Returns
    Type Description
    Node

    The rich text node.

    Overrides
    RectangleToolBase.CreateNode(RectangleF)

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved