RiverSoftAVG Products Help

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Send Mail Feedback
Save Permalink URL

Navigation: Code Documentation > RSVML > RSGdiPlusCtrls > Classes

TRSGPCalloutRectangle Class

A rectangle with a triangular "peak" on one of four sides.

Because TRSGPCalloutRectangle inherits from RSGdiPlusCtrls.TRSGPRectangle , TRSGPCalloutRectangle provides all the properties (Corners, CornerType, Sides, XRadius, YRadius, and others) and methods to define the shape of the rectangle itself.

A call-out often takes the form of a pull-quote, in which a particular snippet of text in a document is duplicated to attract attention: in a larger size, with a different typeface, in a colored box, with stylized quote marks, and so on. With illustrations, boxed text will refer to different elements of interest, and each box will be drawn with extra lines that point to its element.

TRSGPCalloutRectangle is a rectangle with an isosceles triangle on one of its four sides, used to point at something else. The triangle is included in the bounding rectangle of the object: the longer its length, the shorter the rectangle shape will be, and vice versa. Keeping the rectangle the same size while changing the length of the triangle requires changing the height or width of the object, depending on which side the triangle appears.

Namespace: RSGdiPlusCtrls

	Name	Description
	Create(TComponent)	Initializes a new instance of the TRSGPCalloutRectangle class. (Overrides RSGdiPlusCtrls.TRSGPRectangle.Create(TComponent).)
	Destroy	Represents the destructor of the TRSGPCalloutRectangle class. (Overrides RSGdiPlusCtrls.TRSGPShape.Destroy.)

Top

	Name	Description
	AbsoluteMatrix	Specifies the absolute transformation matrix of the control. AbsoluteMatrix is calculated using Matrix and AbsoluteMatrix of its parent (Inherited from RSGdiPlusCtrls.TRSGPShape.)
	Align	Represents property Align. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)
	Anchors	Represents property Anchors. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)
	CalloutLength	The length of the callout pointer. TRSGPCalloutRectangle renders the callout pointer as an isosceles triangle on one of its sides. CalloutLength is the height of this triangle. The triangle is included in the bounding rectangle ShapeRect of the TRSGPCalloutRectangle object; therefore, the longer CalloutLength is, the smaller the height (or width) of the callout rectangle itself is, and vice versa. Keeping the bounding rectangle the same size while changing the length of the triangle CalloutLength requires changing the height or width of the callout rectangle TRSGPCalloutRectangle itself, depending on which side the triangle appears.
	CalloutOffset	The position of the callout pointer, relative to the center or edges of the side on which it appears. TRSGPCalloutRectangle renders the callout pointer as an isosceles triangle on one of its sides. The CalloutPosition defines the side on which the triangle appears. • If CalloutOffset is zero, then the triangle is centered on the specified side. • If CalloutOffset is positive, then the closest point of the callout pointer to a corner of the triangle has the CalloutOffset offset on the following sides: Top--offset to the right from the upper-left corner. Left--offset to the bottom from the upper-left corner. Right--offset to the bottom from the upper-right corner. Bottom--offset to the right from the lower-left corner. • If CalloutOffset is negative, then the closest point of the callout pointer to a corner of the triangle has the CalloutOffset offset on the following sides: Top--offset to the left from the upper-right corner. Left--offset to the top from the lower-left corner. Right--offset to the top from the lower-right corner. Bottom--offset to the left from the lower-right corner.

published property

CalloutPosition

Specifies the side of the rectangle where the callout pointer appears.

TRSGPCalloutRectangle renders its callout pointer as an isosceles triangle on one of its four sides.

Set CalloutPosition to one of the Top, Left, Bottom, or Right constants predefined in TCalloutPosition to define the side on which the callout pointer should appear.

By default, the callout pointer appears on the top side CalloutPosition = Top.

published property

CalloutWidth

The width of the callout pointer.

TRSGPCalloutRectangle renders its callout pointer as an isosceles triangle on one of its sides. CalloutWidth is the length of the base of the triangle.

public property

Canvas

Represents property Canvas. (Inherited from RSGdiPlusCtrls.TRSCustomTransparentGraphicControl.)

published property

ClipChildren

Represents property ClipChildren. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Constraints

Represents property Constraints. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Corners

Specifies shapes of which corners in the TRSGPRectangle rectangle object are customized according to the CornerType, XRadius, and YRadius properties.

By default, all four corners are customized.

Corners can contain a set of constants defined in the TRSCorner type: crTopLeft, crTopRight, crBottomLeft, and crBottomRight. Use the AllCorners constant to select all corners.

If Corners is an empty set or any of the XRadius and YRadius properties is zero, then no corner shape customization is used.

published property

CornerType

Specifies the type of the corner shape's customization in the rectangle. Values of CornerType are defined in TRSGPCornerType.

CornerType applies to corners specified in the Corners set. XRadius and YRadius specify the distance from a corner to the start point of the corner shape customization, on the horizontal and vertical sides.

Note
If Corners is an empty set or any of the XRadius and YRadius properties is zero, then no corner shape customization is used

published property

Cursor

Represents property Cursor. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

DragCursor

Represents property DragCursor. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

DragKind

Represents property DragKind. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

DragMode

Represents property DragMode. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Fill

Represents property Fill. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

public property

InterceptMouse

Determines whether mouse clicks should be detected for the control (Inherited from RSGdiPlusCtrls.TRSCustomTransparentGraphicControl.)

public property

Matrix

Specifies the local transformation matrix of the control (Inherited from RSGdiPlusCtrls.TRSGPShape.)

protected property

NeedUpdate

Represents property NeedUpdate.

published property

OnClick

Represents property OnClick. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnContextPopup

Represents property OnContextPopup. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnDblClick

Represents property OnDblClick. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnDragDrop

Represents property OnDragDrop. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnDragOver

Represents property OnDragOver. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnEndDock

Represents property OnEndDock. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnEndDrag

Represents property OnEndDrag. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnGesture

Represents property OnGesture. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnMouseActivate

Represents property OnMouseActivate. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnMouseDown

Represents property OnMouseDown. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnMouseEnter

Represents property OnMouseEnter. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnMouseLeave

Represents property OnMouseLeave. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnMouseMove

Represents property OnMouseMove. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnMouseUp

Represents property OnMouseUp. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnPaint

Represents property OnPaint. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnPainting

Represents property OnPainting. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnStartDock

Represents property OnStartDock. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

OnStartDrag

Represents property OnStartDrag. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Opacity

Represents property Opacity. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

ParentShowHint

Represents property ParentShowHint. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

PopupMenu

Represents property PopupMenu. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

public property

ShapeRect

Returns the rectangle for drawing the shape.

The coordinates of the upper-left corner of the rectangle are (0,0), and the coordinates of the lower-right corner are (Width, Height).
(Inherited from RSGdiPlusCtrls.TRSGPShape.)

published property

ShowHint

Represents property ShowHint. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Sides

Specifies which sides of the TRSGPRectangle rectangle to display.

A side is a rectangle boundary between two adjacent corners or end points of corner customizations. End points of corner customizations are defined by XRadius and YRadius. A corner customization applies to corners included into the Corners set.

By default, all sides of the rectangle are displayed.

Sides can contain a set of constants defined in TRSSide: sdTop, sdLeft, sdBottom, and sdRight. Use the AllSides constant to select all sides.

If Sides is empty, then no side is displayed.

published property

Stroke

Represents property Stroke. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Touch

Represents property Touch. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Transform

Represents property Transform. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

Visible

Represents property Visible. (Inherited from RSGdiPlusCtrls.TRSGPRectangle.)

published property

XRadius

Specifies the distance from a corner to the start point of the corner shape customization, on the horizontal sides of TRSGPRectangle.

During design time, the maximum possible value of XRadius is limited by the half of the smallest side.

If XRadius=0, then no corner shape customization is used.

published property

YRadius

Specifies the distance from a corner to the start point of the corner shape customization, on the vertical sides of TRSGPRectangle.

During design time, the maximum possible value of YRadius is limited by the half of the smallest side.

If YRadius=0, then no corner shape customization is used.

Top

	Name	Description
	CreateGdiPCanvas	Creates a GDI+ canvas for the control. The calling routine is responsible for freeing the GDI+ canvas (Inherited from RSGdiPlusCtrls.TRSCustomTransparentGraphicControl.)
	DoPaint	Override this method to paint the control (Overrides RSGdiPlusCtrls.TRSCustomTransparentGraphicControl.DoPaint.)
	DoPainted	Occurs just after painting. Calls the OnPaint event (Inherited from RSGdiPlusCtrls.TRSCustomTransparentGraphicControl.)
	DoPainting	Occurs just before painting. Calls the OnPainting event (Inherited from RSGdiPlusCtrls.TRSCustomTransparentGraphicControl.)
	GetAbsoluteMatrix	Returns the absolute transformation matrix of the control. AbsoluteMatrix is calculated using Matrix and AbsoluteMatrix of its parent (Inherited from RSGdiPlusCtrls.TRSGPShape.)
	GetMatrix	Returns the local transformation matrix of the control (Inherited from RSGdiPlusCtrls.TRSGPShape.)
	GetOpacity	Returns the control opacity. (Inherited from RSGdiPlusCtrls.TRSGPShape.)
	GetShapeRectForRot(TObject,TRSRect)	Represents method GetShapeRectForRot(TObject,TRSRect). (Inherited from RSGdiPlusCtrls.TRSGPShape.)
	ObjectChanged(TObject)	Represents method ObjectChanged(TObject). (Inherited from RSGdiPlusCtrls.TRSGPShape.)
	Paint(TRSGPCanvas,TRSGPMatrix,Single)	Represents method Paint(TRSGPCanvas,TRSGPMatrix,Single). (Overrides RSGdiPlusCtrls.TRSGPRectangle.Paint(TRSGPCanvas,TRSGPMatrix,Single).)
	PointInObject(Integer,Integer)	Overloaded. Checks whether the point, specified by the absolute coordinates, belongs to the control area. PointInObject returns True if the specified point belongs to the control area, and False otherwise. The X and Y are the absolute coordinates (relative to the main form) of the point to be checked. The points of the control boundary specified by BoundsRect belong to the control and PointInObject returns True for them.
	PointInObject(Single,Single)	Overloaded. Checks whether the point, specified by the absolute coordinates, belongs to the control area. PointInObject returns True if the specified point belongs to the control area, and False otherwise. The X and Y are the absolute coordinates (relative to the main form) of the point to be checked. The points of the control boundary specified by BoundsRect belong to the control and PointInObject returns True for them.
	Resize	Represents method Resize.
	SetOpacity(Single)	Sets the control opacity. Set Opacity to customize the transparency of the current control. Opacity takes values between 0 and 1. If Opacity is 1, the control is completely opaque; if it is 0, the control is completely transparent. The values over 1 are treated as 1, and the ones under 0 are treated as 0. Opacity applies to the control's children.
	UpdateShape	Represents method UpdateShape.

Top

RiverSoftAVG Products Help

Reference