How to adapt a custom extension to the current theme

Created
October 08, 2021 23:17

Date Posted: 2019-11-20
Product: TIBCO Spotfire®

Problem:

Solution:

You can use the Document.GetStyle() method to get the style properties of elements in the user interface. There are various related classes such as StyleProperties, ColorInfo, FontStyle, FontWeight etc. See the attached image (Filename:Styling API.png) to get a brief idea about these classes. In the RenderCore() of the CustomVisualization you can use the Document.GetStyle() to get the current theme of the Analysis and then use this in the visual to adapt.

Example:

var visualContentStyle = document.GetStyle(StyleElement.VisualContent);
            var backgroundColor = visualContentStyle.GetEffectiveBackgroundColor();
            using (Brush backgroundBrush = new SolidBrush(backgroundColor))
            using (Pen backgroundPen = new Pen(backgroundColor))
            {
                renderArgs.Graphics.DrawRectangle(backgroundPen, renderArgs.Bounds);
                renderArgs.Graphics.FillRectangle(backgroundBrush, renderArgs.Bounds);
            }

Refer to the RenderCore() in the TrafficLightchart.cs or CustomScatterPlot.cs of the CustomVisualsExample available with the SDK on how to manage the visualizations to blend in with the theme in the analysis. Documentation: