|
AfterConstruction
|
Represents method AfterConstruction.
|
|
BeginUpdate
|
Prevents the updating of the instrument until the EndUpdate method is called.
BeginUpdate prevents the screen from being repainted and OnChange events being triggered when instrument properties are changed. Use BeginUpdate to prevent screen repaints and to speed processing time while modifying the instrument.
Note: Calls to BeginUpdate are cumulative; for every call to BeginUpdate there must be a corresponding call to EndUpdate.
|
|
ChangeGradientColor(TSVGCustomGradient,TSVGColor,Boolean)
|
Overloaded. Attempts to modify a gradient color scheme to a similar color scheme using NewColor, i.e., if a gradient has 3 gradient stops of dark gray, gray, white and the NewColor is Red, the method will try to change the gradient to red, lighter red, and white.
The FromFirst parameter specifies if the first or the last gradient stop is the base color to replace. The base color is replaced with the NewColor unchanged. All other gradient stops are modified from the base color.
|
|
ChangeGradientColor(TSVGCustomGradient,TSVGColor,Integer)
|
Overloaded. Attempts to modify a gradient color scheme to a similar color scheme using NewColor, i.e., if a gradient has 3 gradient stops of dark gray, gray, white and the NewColor is Red, the method will try to change the gradient to red, lighter red, and white.
The BaseColorIndex parameter specifies if which gradient stop is the base color to replace. The base color is replaced with the NewColor unchanged. All other gradient stops are modified from the base color.
|
|
DoEnableGradient(String,String,Boolean,TSVGColor,Boolean)
|
Helper method for changing a SVG element's color between a gradient or a solid color.
The IsEnabled parameter specifies whether to set the element to the gradient or the solid color.
The IsBrush parameter specifies whether to change the element's brush or pen properties.
|
|
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.
|
|
DoOnChange
|
Triggers the OnChange event
|
|
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.
|
|
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.
|
|
EndUpdate
|
Re-enables screen repainting and change events that were turned off with the BeginUpdate method.
Use the EndUpdate method to enable screen updating after BeginUpdate has been called. Calls to BeginUpdate are cumulative, so calling EndUpdate will only update the instrument if every other call to BeginUpdate has already been matched by a call to EndUpdate.
|
|
GetSVGResourceName
|
Returns the name of the resource that contains the SVG. The class uses this name to load the embedded SVG from a resource.
|
|
InitializeGauge
|
Initializes the SVG gauge or instrument from the class properties, i.e., apply the properties to the SVG.
This method calls the DoInitializeGauge method to actually initialize the SVG based on the class properties. It is recommended that descendant classes override that method to respond to initialization requests.
This method ensures that the buffers get updated and the control is repainted.
|
|
IsUpdating
|
Returns true if the instrument is being updated
|
|
LoadSVGProperties
|
Initializes local properties from the SVG. Descendant classes override this method to initialize their properties (such as FrameColor) from elements in the SVG.
|
|
RestoreGradientColor(TSVGCustomGradient)
|
Restores the gradient stop colors from the tags of the SVG elements, previously saved using SaveGradientColor.
|
|
SaveGradientColor(TSVGCustomGradient)
|
Stores gradient stop colors in the tags of the SVG elements. This allows restoring the gradient stop colors without reloading the svg
|
|
UpdateDecoration
|
Updates the shape of the decoration ( DecorationPath) based on changes to the Decoration property.
|
|
UpdateDecorationFill
|
Updates the Decoration fill color in the gauge
|
|
UpdateDecorationStroke
|
Updates the Decoration stroke color in the gauge
|
|
UpdateDesign
|
Updates the design of the gauge based on the Design property. Simpler designs hide elements in the SVG while detailed designs show all elements of the SVG.
This method calls the DoUpdateDesign method to actually change the SVG based on the Design property. It is recommended that descendant classes override DoUpdateDesign method to respond to design changes.
This method ensures that the buffers get updated and the control is repainted.
|
|
UpdateGradients
|
This method enables or disables gradients in the SVG for the instrument based on EnableGradients property changes.
This method calls the DoEnableGradients method to actually enable/disable gradients in the SVG. It is recommended that descendant classes override that method to enable/disable the gradients.
This method ensures that the buffers get updated and the control is repainted.
|
|
UpdateLight
|
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.
This method calls the DoUpdateLight method to actually perform any color changes in the SVG. It is recommended that descendant classes override that method to do the actual changes.
This method ensures that the buffers get updated and the control is repainted.
|
|
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
|
|
UpdateParts
|
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.
This method calls the DoUpdateParts method to actually perform any changes to the SVG. It is recommended that descendant classes override that method to do the actual changes.
This method ensures that the buffers get updated and the control is repainted.
|