Class SfSmithChart

Represents the SmithChart control which is used to visualize the data graphically.

Inheritance
System.Object
BaseControl
SfSmithChart
Implements
System.IDisposable
Inherited Members
Namespace: Syncfusion.WinForms.SmithChart
Assembly: Syncfusion.SfSmithChart.WinForms.dll
Syntax
public class SfSmithChart : BaseControl, IThemeProvider, IVisualStyle, IDisposable

Constructors

SfSmithChart()

Initializes a new instance of the SfSmithChart class.

Declaration
public SfSmithChart()

Properties

AccessibilityEnabled

Gets or sets a value indicating whether the control should enable its Accessibility support.

Declaration
public bool AccessibilityEnabled { get; set; }
Property Value
Type
System.Boolean

BackColor

Gets or sets the back color for the chart.

Declaration
public override Color BackColor { get; set; }
Property Value
Type
System.Drawing.Color

ColorModel

Gets or sets the palette for chart.

Declaration
public ChartColorModel ColorModel { get; set; }
Property Value
Type
ChartColorModel

Font

Gets or sets the font for the smith chart text.

Declaration
public override Font Font { get; set; }
Property Value
Type
System.Drawing.Font

ForeColor

Gets or sets the fore color for the control text.

Declaration
public override Color ForeColor { get; set; }
Property Value
Type
System.Drawing.Color

HorizontalAxis

Gets or sets the style for the horizontal axis.

Declaration
public HorizontalAxis HorizontalAxis { get; set; }
Property Value
Type
HorizontalAxis

Legend

Gets or sets the legend for smith chart. Please refer to ChartLegend for more information.

Declaration
public ChartLegend Legend { get; set; }
Property Value
Type
ChartLegend

RadialAxis

Gets or sets the style for the radial axis.

Declaration
public RadialAxis RadialAxis { get; set; }
Property Value
Type
RadialAxis

Radius

Gets or sets the Circle radius Coefficient value to shrink the circle. It's range is from 0.1 to 1 and default value is 0.95.

Declaration
public float Radius { get; set; }
Property Value
Type
System.Single

RenderingMode

Gets or sets the rendering type of the chart.

Declaration
public RenderingMode RenderingMode { get; set; }
Property Value
Type
RenderingMode

Series

Gets or sets the collection of series.

Declaration
public ChartSeriesCollection Series { get; set; }
Property Value
Type
ChartSeriesCollection

Style

Gets or sets the ChartStyle value used to customize the appearance of the smith chart.

Declaration
public ChartStyle Style { get; set; }
Property Value
Type
ChartStyle

Text

Gets or sets the text for the chart control.

Declaration
public override string Text { get; set; }
Property Value
Type
System.String

TitleAlignment

Gets or sets the chart title alignment horizontally.

Declaration
public StringAlignment TitleAlignment { get; set; }
Property Value
Type
System.Drawing.StringAlignment

TooltipOptions

Gets or sets the customization options for tooltip.

Declaration
public TooltipOptions TooltipOptions { get; set; }
Property Value
Type
TooltipOptions

Methods

BeginUpdate()

Suspends the painting of the control until the EndUpdate() method is called.

Declaration
public void BeginUpdate()

CopyToClipboard()

Copy the smith chart bitmap image in to clipboard.

Declaration
public void CopyToClipboard()

CreateAccessibilityInstance()

Overridden to update the accessibility object for the smith chart.

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
Type Description
System.Windows.Forms.AccessibleObject

Returns the accessibility object for the smith chart.

Dispose(Boolean)

Dispose this control and its children.

Declaration
protected override void Dispose(bool disposing)
Parameters
Type Name Description
System.Boolean disposing

true to release both managed and unmanaged resources; false to release only unmanaged resources.

EndUpdate()

Resumes the painting of the control suspended by calling the BeginUpdate() method.

Declaration
public void EndUpdate()

GetControlName(String)

Helps to set the Control name

Declaration
public override string GetControlName(string controlName)
Parameters
Type Name Description
System.String controlName

Control Name
Returns
Type Description
System.String

Control name
Overrides

OnKeyDown(KeyEventArgs)

Invoked when the KeyDown attached event reaches an element in its route that is derived from this class. Implement this method to add class handling for this event.

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.KeyEventArgs e

The that contains the event data.

OnMouseMove(MouseEventArgs)

Overridden to show the tooltip for smith chart data points.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.MouseEventArgs e

event arguments

OnPaint(PaintEventArgs)

Overrides the System.Windows.Forms.Control.Paint event.

Declaration
protected override void OnPaint(PaintEventArgs e)
Parameters
Type Name Description
System.Windows.Forms.PaintEventArgs e

A System.Windows.Forms.PaintEventArgs that contains the event data.

OnRightToLeftChanged(EventArgs)

Occurs on Changing the RTL mode of the smith chart.

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

An System.EventArgs that contains event data.

OnSizeChanged(EventArgs)

Raises the System.Windows.Forms.Control.SizeChanged event.

Declaration
protected override void OnSizeChanged(EventArgs e)
Parameters
Type Name Description
System.EventArgs e

event argument

OnThemeNameChanged(String)

Helps to apply the ThemeName customization

Declaration
public override void OnThemeNameChanged(string themeName)
Parameters
Type Name Description
System.String themeName

Control ThemeName
Overrides

RaiseThemeChanged(Object, ThemeChangedEventArgs)

Raises the ThemeNameChanged and ThemeChanged event when theme name changed.

Declaration
protected override void RaiseThemeChanged(object sender, ThemeChangedEventArgs args)
Parameters
Type Name Description
System.Object sender

The sender value.
ThemeChangedEventArgs args

A ThemeChangedEventArgs contains the event data.
Overrides

SaveImage(String)

Declaration
public void SaveImage(string fileName = null)
Parameters
Type Name Description
System.String fileName

Events

ThemeChanged

Occurs when theme name of the SfSmithChart has changed.

Declaration
public event ThemeChangedEventHandler ThemeChanged
Event Type
Type
ThemeChangedEventHandler

TooltipOpening

Occurs before the point's tooltip open and used to customize the tooltip text and styles.

Declaration
public event EventHandler<TooltipOpeningEventArgs> TooltipOpening
Event Type
Type
System.EventHandler<TooltipOpeningEventArgs>

Implements

System.IDisposable