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 > RSVclSVG > RSSVGCtrls > Classes

TRSSVGScreen Class

TRSSVGScreen control displays a graphical image of an SVG. The control ensures that the image is always of the highest resolution by redrawing the SVG when the control is rescaled.

Use TRSSVGScreen to display a graphical image of a SVG on a form. Use the SVGDocument and SVGRootID properties to control which SVG is displayed in the image. TRSSVGScreen introduces several properties to determine how the SVG is displayed within the boundaries of the TRSSVGScreen object.

The TRSSVGScreen class is a VCL only control.

Important Note
Unlike the RSSVGCtrls.TRSSVGImage control, the TRSSVGScreen control is not transparent. Stacking TRSSVGScreen controls on top of each other will obscure the ones underneath. However, the TRSSVGScreen control can display SVGs without flicker (though tearing can still occur)

Namespace: RSSVGCtrls

	Name	Description
	AbsoluteMatrix	Returns the combined transformation matrix for the control. This is the control's transformation matrix multiplied by all parent IRSGPControl control's transformation matrices.
	Align	Represents property Align.
	Anchors	Represents property Anchors.
	AutoSize	Represents property AutoSize.
	Bitmap	Represents property Bitmap.
	Buffered	Specifies whether to draw the SVG to a backbuffer and then copy that image to the canvas (default) or to draw directly on the canvas Set the Buffered property to false to draw directly on the image canvas. This is generally not recommended, however, it may look better on mobile devices
	Constraints	Represents property Constraints.
	Cursor	Represents property Cursor.
	CursorTracking	Represents property CursorTracking.
	DefaultCursor	Represents property DefaultCursor.
	DragCursor	Represents property DragCursor.
	DragKind	Represents property DragKind.
	DragMode	Represents property DragMode.
	Enabled	Represents property Enabled.
	FindOptions	Specifies how the control determines which svg element is at the mouse cursor
	Matrix	Returns the transformation matrix of the control
	NeedBitmapUpdate	Represents property NeedBitmapUpdate.
	OnClick	Represents property OnClick.
	OnContextPopup	Represents property OnContextPopup.
	OnDblClick	Represents property OnDblClick.
	OnDragDrop	Represents property OnDragDrop.
	OnDragOver	Represents property OnDragOver.
	OnEndDock	Represents property OnEndDock.
	OnEndDrag	Represents property OnEndDrag.
	OnGesture	Represents property OnGesture.
	OnMouseActivate	Represents property OnMouseActivate.
	OnMouseDown	Represents property OnMouseDown.
	OnMouseEnter	Represents property OnMouseEnter.
	OnMouseLeave	Represents property OnMouseLeave.
	OnMouseMove	Represents property OnMouseMove.
	OnMouseUp	Represents property OnMouseUp.
	OnPaint	Represents property OnPaint.
	OnPainting	Represents property OnPainting.
	OnStartDock	Represents property OnStartDock.
	OnStartDrag	Represents property OnStartDrag.
	Opacity	Specifies the opacity or transparency of the SVG image. If Opacity is less than 1, then the SVG is displayed semi- transparent. If Opacity is 0, then the SVG is not displayed.
	ParentShowHint	Represents property ParentShowHint.
	PopupMenu	Represents property PopupMenu.
	Quality
	ScaleOriginal	Specifies the scale factor for drawing the SVG. Use the ScaleOriginal property to scale the SVG larger or smaller within the TRSSVGImage component. This is useful for controlling the tiling the SVG or zooming in or out of the SVG
	ShowHint	Represents property ShowHint.
	SVGDocument	Specifies the SVG document to display in the control. The SVGDocument and SVGRootID properties control exactly which SVG document and which branch of the SVG document hierarchy to display.
	SVGRoot	Represents property SVGRoot.
	SVGRootID	Specifies which node of the SVGDocument to draw as the top- level SVG document. Use the SVGRootID property to display only a portion of the SVGDocument .
	Touch	Represents property Touch.
	Transform	Specifies the overall transformation to apply to the SVG image. For no transformation, set the Matrix to the RSIdentityMatrix
	Visible	Represents property Visible.
	WrapMode	Specifies whether and how to resize, replicate, and position the SVG image for rendering the TRSSVGImage surface. The WrapMode property should be one of the constants defined in the TSVGImageWrapMode type: iwOriginal-- displays the SVG with its original dimensions. iwFit-- best fit (keeping SVG proportions--the ratio between the width and height) for the TRSSVGImage rectangle. Default. iwStretch--stretches the SVG to fill the entire rectangle of this TRSSVGImage component. iwTile--tiles the TRSSVGImage image to cover the entire rectangle of the TRSSVGImage component. iwCenter-- center the SVG inside the TRSSVGImage component

Top

	Name	Description
	DoElementClick(TSVGPoint)	Represents method DoElementClick(TSVGPoint).
	DoPaint	Represents method DoPaint.
	DoPainted	Represents method DoPainted.
	DoPainting	Represents method DoPainting.
	DoSVGChanged(TObject)	Represents method DoSVGChanged(TObject).
	GetAbsoluteMatrix	Returns the combined transformation matrix for the control. This is the control's transformation matrix multiplied by all parent IRSGPControl control's transformation matrices.
	GetMatrix	Returns the transformation matrix of the control
	GetOpacity	Returns the Opacity of the control
	GetShapeRect(TObject,TRSRect)	Represents method GetShapeRect(TObject,TRSRect).
	GetSVGRoot	Represents method GetSVGRoot.
	IsBuffered	Returns True if the SVG should be drawn to a offscreen bitmap
	MouseMove(TShiftState,Integer,Integer)	Represents method MouseMove(TShiftState,Integer,Integer).
	MouseUp(TMouseButton,TShiftState,Integer,Integer)	Represents method MouseUp(TMouseButton,TShiftState,Integer,Integer).
	Notification(TComponent,TOperation)	Represents method Notification(TComponent,TOperation).
	ObjectChanged(TObject)	Represents method ObjectChanged(TObject).
	Paint	Represents method Paint.
	Resize	Represents method Resize.
	SetCursorFromSVG(TSVGPoint)	Represents method SetCursorFromSVG(TSVGPoint).
	SetOpacity(Single)	Sets the opacity of the control. If Opacity is less than 1, then the SVG is displayed semi- transparent. If Opacity is 0, then the SVG is not displayed.
	UpdateBitmap	Represents method UpdateBitmap.

Top

Name

Description

published event

OnClickElement

Occurs when the clicks the mouse in the control. The Element parameter specifies the element that was under the mouse cursor, or nil if no element was under the mouse.

The RSSVGCtrls.TRSSVGScreen.FindOptions property specifies how the control determines which svg element is under the mouse cursor.

Top

Tip
The TRSSVGScreen always loads and draws the SVG image from the TRSSVGDocument in the context of the main GUI thread. For more complex SVG documents, you may want to use the TRSSVGThreadImage control to load and draw a SVG within a background thread.

Warning
If the SVGRootID property is not empty, the ID must exist in the SVG document or nothing is displayed.

To load and draw a SVG at run-time, create the SVG document and the SVG Screen:

Delphi
SVGDoc := TRSSVGDocument.Create(Self); SVGDoc.Filename := 'c:\MySVG.svg'; SVGScreen := TRSSVGScreen.Create(Self); SVGScreen.Parent := Self; SVGScreen.SVGDocument := SVGDoc;

At design-time, you would:

• Drop an SVG document component on your form ( RSSVGCtrls.TRSSVGDocument for VCL, TRSFMXSVGDocument for FMX) SelectComponentVcl

• Set the TRSSVGDocument.Filename property to the SVG file. Alternatively, you can directly paste the SVG into the Lines property (warning: Delphi's TStrings editor will truncate long lines causing problems with some SVG text)

• Drop a TRSSVGScreen component on the form

• Connect the TRSSVGScreen.SVGDocument to the RSSVGDocument1 (VCL) SelectSVGDocVcl

• Optionally, if you only want to display one branch of the SVG document, you can set the TRSSVGScreen.SVGRoot property to the SVG element you want to display. If the SVGRoot is not empty and it does not equal any SVG element in the document, nothing is displayed.

RiverSoftAVG Products Help

Reference