RiverSoftAVG Products Help

DoEnableGradients(Boolean)

This method enables or disables gradients in the SVG for the instrument.

Descendant classes override this method to respond to     EnableGradients property changes.

DoInitializeGauge

Initializes the SVG gauge or instrument from the class properties, i.e., apply the properties to the SVG.

Descendant classes override this method to initialize the SVG that draws the gauge with their properties.

DoUpdateCaptionFont

Updates the font for the RS.Impact.Instruments.TRSCustomCircularGauge.Caption and the RS.Impact.Instruments.TRSCustomCircularGauge.DetailText based on the RS.Impact.Instruments.TRSCustomCircularGauge.CaptionFont changes.

DoUpdateDesign

Updates the SVG design of the instrument to simple or detailed based on Design property.

Descendant classes override this method to modify the SVG in response to     Design property changes. Simple designs usually mean making some extra element's invisible.

DoUpdateElement(String,Single)

Updates the rotation angle for the SVG element specified by ElementID. This is the method that rotates the clock hands or the compass needle.

DoUpdateFont

Updates the font for the labels on the outside of the gauge based on RS.Impact.Instruments.TRSCustomCircularGauge.Font property changes.

DoUpdateLight

Updates colors of SVG elements based on changes in the LightColor property.

Descendant classes can override this method to provide a color cast to the SVG based on     LightColor changes.

DoUpdateParts

Update the parts of the SVG based on changes to the Parts property.

Descendant classes override this method to show or hide different elements in the SVG based on Parts property changes.

FontChanged(TObject)

This method is called when the Font or CaptionFont is changed. This method calls the DoUpdateFont or DoUpdateCaptionFont method to update the correct elements of the gauge.

GetClosestMajorMarker(Single)

Returns the index of the closest major marker to the specified 0-360 degree angle.

GetDefaultLabels

Returns the default multi-line string (separated by #13#10) for the outside labels of the gauge

GetMarkerData(TMarker,Boolean)

Returns the path data that define the shape of major (IsSmall = False) or minor (IsSmall = True) markers

GetSVGResourceName

Returns the name of the resource that contains the SVG. The class uses this name to load the embedded SVG from a resource. (Overrides RS.Impact.Instruments.TRSSVGCustomInstrument.GetSVGResourceName.)

InitializeHands

Shows or hides the SVG elements that represent the Hands based on their presence in the   Hands property set.

InitializeLabels

Initializes the text elements that represent the labels on the outside of the gauge. The text elements are initialized with values from the   Labels property.

InitializeMarkerPaths

Initializes   MajorMarkerPath and   MinorMarkerPath properties based on the   MajorMarker and   MinorMarker enumerated values

InitializeMarkers

Creates the major and minor markers around the gauge based on the number of   MajorMarkers and the number of   MinorMarkers between them. The   StartAngle and   StopAngle properties control where the markers start and end on the circle. The shape of the markers depend on the   MajorMarkerPath and   MinorMarkerPath properties.

InitializeNumberLabels

Initializes the labels on the outside of the gauge with numbers based on the   Min and   Max properties and how many   MajorMarkers have been specified.

LabelsChanged(TObject)

This method is called when the RS.Impact.Instruments.TRSCustomCircularGauge.Labels property changes. This method responds to Labels changes by calling the RS.Impact.Instruments.TRSCustomCircularGauge.InitializeLabels method to update label elements in the gauge.

LoadSVGProperties

Initializes local properties from the SVG. Descendant classes override this method to initialize their properties (such as FrameColor) from elements in the SVG. (Overrides RS.Impact.Instruments.TRSSVGCustomInstrument.LoadSVGProperties.)

LoadSVGResource(string)

Load the SVG from an embedded resource. This method initializes the   ActiveSVGElement property and should be used to initialize any control fields (such as colors) that are dependant on the values in the SVG. (Overrides RSSVGControl.TRSSVGControl.LoadSVGResource(String).)

MarkersChanged(TObject)

This method is called when the RS.Impact.Instruments.TRSCustomCircularGauge.MajorMarkerPath or RS.Impact.Instruments.TRSCustomCircularGauge.MinorMarkerPath property are changed and the underlying gauge elements need to be updated. The method calls the RS.Impact.Instruments.TRSCustomCircularGauge.InitializeMarkers method to update markers based on their new shape.

UpdateDecoration

Updates the shape of the decoration (   DecorationPath) based on changes to the   Decoration property. (Overrides RS.Impact.Instruments.TRSSVGCustomInstrument.UpdateDecoration.)

UpdateHands

Updates the orientation of the   Hands based on the   Value property.

UpdateNumbers

This method updates any text elements that display numbers in the gauge. This method is called when the     FormatStr property changes so that the class can respond to new formatting for numbers.

Descendant classes should override this method to update any text elements with numbers

UpdateTime

Updates the orientation of the   Hands based on the   Time property.