Type parameters:
| T | where IDocumentObject |
Constructors
Properties
AggregateBounds
#public RectangleF AggregateBounds { get; }
Gets the aggregate bounds of this object. This will include the bounds of all objects attached in some way to this object.
Implements: AggregateBounds
Bounds
#public RectangleF Bounds { get; protected set; }
Gets the total outer bounds of the attributes. The attributes are assumed not to exist beyond this limit. Note that the bounds are updated during calls to Layout(), so may be out-of-date or even unset when called outside of the usual process.
Implements: Bounds
IntegerPivot
#Gets whether the pivot of these attributes is always rounded to integer coordinates. By default this property returns true, as the vast majority of objects ought to be laid out in integer coordinates.
Owner
#public T Owner { get; }
Pivot
#public PointF Pivot { get; set; }
Gets or sets the pivot point for these attributes. The pivot is the main point around which the attribute geometry is positioned during layout.
Implements: Pivot
Snappable
#Gets whether these attributes can be used to align other objects on the canvas. Return false specifically when your object shape is not rectangular.
Implements: Snappable
Stack
#The horizontal layout stack along the apex row. Derived classes typically (re)assign this during Layout(Shape) and reference sub-regions via class-local index constants. The default PivotMoved(PointF, PointF) translates the stack along with Bounds.
Methods
DefaultTooltipContent
#Create the tooltip fields which are associated with this object by default.
Parameters:
| point (PointF) | Point for tooltip. |
| icon (out IIcon) | Icon. |
| caption (out string) | Caption text. |
| message (out string) | Message text. |
| details (out object) | Either text or an Action<Context, Rectangle> or null. |
| warnings (out bool) | Boolean flag indicating the existence of warnings. |
| errors (out bool) | Boolean flag indicating the existence of errors. |
Returns: True if a tooltip ought to be shown for this object at the given location.
Draw
#Internal drawing method. Consider overriding this one instead of Draw(Context, Skin).
Draw
#Render the owner object of these attributes.
HandleDoubleClick
#Handle a double click operation on these attributes. Since this is such a common operation it is provided by the base interface, rather than requiring an IResponseAttribues implementation.
Parameters:
| point (PointF) |
Implements: HandleDoubleClick
Intersects
#Test whether a given rectangle intersects the shape of these attributes.
Parameters:
| box (RectangleF) | Intersection box. |
Returns: True if rectangle intersects these attributes.
Implements: Intersects
InvalidateDisplay
#public virtual void InvalidateDisplay()
Signals that the attribute's visual appearance has changed without affecting layout. Fires the owner's DocumentObject.OnDisplayChanged(), which propagates through the document to the canvas redraw subscription.
Implements: InvalidateDisplay
InvalidateLayout
#public abstract void InvalidateLayout()
Marks the layout as dirty so it gets recomputed on the next draw cycle. Subclasses typically flip an internal
_layoutValid flag. Most callers should also raise DocumentObject.OnLayoutChanged() on the owner to actually trigger a canvas redraw.Implements: InvalidateLayout
IsCoincident
#Test whether a given point is considered to be on the interior of these attributes.
Parameters:
| point (PointF) | Test point. |
Returns: True if point is on the object.
Implements: IsCoincident
IsContained
#Test whether the shape of these attributes is fully contained within a given rectangle.
Parameters:
| box (RectangleF) | Containment box. |
Returns: True if rectangle contains these attributes.
Implements: IsContained
Layout
#public abstract void Layout(Shape shape)
Perform a layout operation on these attributes. Layout() ought to be called as part of every control painting process.
Move
#Move these attributes a certain amount in X and Y.
PivotMoved
#protected virtual void PivotMoved(PointF oldPivot, PointF newPivot)
Override this method if your attributes need to handle pivot motion. The default implementation translates Bounds and Stack by the pivot delta. Overrides should typically chain to this base implementation.
Parameters:
| oldPivot (PointF) | |
| newPivot (PointF) |
ShowTooltipAt
#Display the tooltip at the given point. The tooltip can be accessed via Tooltip.
Parameters:
| point (PointF) | Location of pointer. |
Returns: True if tooltip was shown.
Implements: ShowTooltipAt
TooltipDetails
#Override this method to return custom details for a tooltip.
Parameters:
| point (PointF) | |
| state (ObjectSolutionState) |
Returns: One of the acceptable types of data for details. For example an array of LazyStrings or a Action<Context, RectangleF>.