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 > RSGdiPlusGraphics > Classes

TRSGPCustomLineCap Class

Encapsulates a custom line cap. A line cap defines the style of graphic used to draw the ends of a line. It can be various shapes, such as a square, circle, or diamond. A custom line cap is defined by the path that draws it. The path is drawn by using a Pen object to draw the outline of a shape or by using a Brush object to fill the interior. The cap can be used on either or both ends of the line. Spacing can be adjusted between the end caps and the line.

Namespace: RSGdiPlusGraphics

	Name	Description
	Create(TRSGPCanvas)	Constructs the graphics object. Specify the canvas that owns the graphics object. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Create(TRSGPCanvas).)
	Destroy	Represents the destructor of the TRSGPCustomLineCap class. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Destroy.)

Top

Name

Description

published property

BaseCap

Specifies the LineCap that appears as part of this CustomLineCap at the end of a line.

published property

BaseInset

Specifies the base inset value of this custom line cap. This is the distance between the end of a line and the base cap.

Warning
If this value is greater than the length of the line, the behavior of this method is undefined.

published property

EndCap

Specifies the line cap that will be used for the end of the line to be drawn.

public property

Handle

Handle of the graphics object, used by the MS GDI+ flat API routines (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

published property

Join

Specifies the line join that will be used for two lines that are drawn by the same pen and that have overlapping ends.

public property

OnChange

Occurs when the graphics object changes.

Note
There are two events that are exactly the same, OnChanged and OnChange. The extra event name is to allow easier transition from other Delphi libraries, either the VCL (OnChanged) or FMX (OnChange) libraries. Use either one as needed. Only one event is triggered.

public property

OnChanged

Occurs when the graphics object changes.

Note
There are two events that are exactly the same, OnChanged and OnChange. The extra event name is to allow easier transition from other Delphi libraries, either the VCL (OnChanged) or FMX (OnChange) libraries. Use either one as needed. Only one event is triggered.

public property

Owner

Canvas that owns the object. The Canvas will free this graphics object if it is destroyed. However, to keep memory use under control, it is recommended that you free graphics objects when you are finished with them. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

public property

Path

Specifies the path shape of the custom line cap.

Important Note
The path shape should be fitted to the RectF(-0.5,-0.5,0.5,0.5)

published property

PathData

Specifies the path shape as a string.

Important Note
The path shape should be fitted to the RectF(-0.5,-0.5,0.5,0.5)

published property

StartCap

Specifies the line cap that will be used for the start of the line to be drawn.

published property

UsePathAsFill

Controls whether the path that defines the custom line cap is used as a Fill path (True) or a Pen path (False)

published property

WidthScale

Specifies the scaling factor that will be used to scale the line width. This is the amount to scale the custom line cap relative to the width of the Pen used to draw lines. The default value of 1.0 does not scale the line cap.

Top

	Name	Description
	Assign(TPersistent)	Represents method Assign(TPersistent).
	Changed	Call this method when the graphics object changes. It triggers an OnChange event. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	Clone	Creates a copy of the graphics object (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	GetHandle	Call this method to acquire a handle from the GDI+ flat API library (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.GetHandle.)
	IsValid	Returns true if the line cap is valid
	Notification(TRSGPCanvas)	Called when the Canvas is releasing control of the graphics object. The canvas will no longer be responsible for freeing the graphics object. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	PathChanged(TObject)	Represents method PathChanged(TObject).
	Prepare(TRectF,Single)	Prepare the graphics object for drawing. Graphics objects respond in this method to upcoming calls. For example, gradient brushes can make sure the gradient will cover the entire rectangle. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	QueryInterface(TGUID,Void)	Represents method QueryInterface(TGUID,Void). (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	ReleaseHandle	Releases the underlying GDI+ object back to the GDI+ library. (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.ReleaseHandle.)
	Update	Update native graphics object (Overrides RSGdiPlusGraphics.TRSGPGraphicsObject.Update.)
	_AddRef	Represents method _AddRef. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)
	_Release	Represents method _Release. (Inherited from RSGdiPlusGraphics.TRSGPGraphicsObject.)

Top

RiverSoftAVG Products Help

Reference