Class CircularPointer

CircularPointer is a class that includes properties and methods to define different types of pointers

Inheritance

System.Object

CircularPointer

Implements

System.IDisposable

Namespace: Syncfusion.UI.Xaml.Gauges

Assembly: Syncfusion.SfGauge.UWP.dll

Syntax

public class CircularPointer : Control, IDisposable

Constructors

CircularPointer()

Initializes a new instance of the CircularPointer class.

Declaration

public CircularPointer()

Fields

AnimationDurationProperty

Declaration

public static readonly DependencyProperty AnimationDurationProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

EnableAnimationProperty

Declaration

public static readonly DependencyProperty EnableAnimationProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

EnableDraggingProperty

Declaration

public static readonly DependencyProperty EnableDraggingProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

KnobRadiusFactorProperty

Declaration

public static readonly DependencyProperty KnobRadiusFactorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

KnobStrokeProperty

Gets or sets the KnobStroke property.

Declaration

public static readonly DependencyProperty KnobStrokeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

KnobStrokeThicknessProperty

Gets or sets the KnobStrokeThickness property.

Declaration

public static readonly DependencyProperty KnobStrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

NeedleLengthFactorProperty

Using a DependencyProperty as the backing store for NeedleLengthFactor. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty NeedleLengthFactorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

NeedlePointerStrokeProperty

Declaration

public static readonly DependencyProperty NeedlePointerStrokeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

NeedlePointerStrokeThicknessProperty

Declaration

public static readonly DependencyProperty NeedlePointerStrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

NeedlePointerTypeProperty

Using a DependencyProperty as the backing store for NeedlePointerType. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty NeedlePointerTypeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

NeedlePointerVisibilityProperty

Declaration

public static readonly DependencyProperty NeedlePointerVisibilityProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PointerCapDiameterProperty

Declaration

public static readonly DependencyProperty PointerCapDiameterProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PointerCapStrokeProperty

Declaration

public static readonly DependencyProperty PointerCapStrokeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

PointerTypeProperty

Declaration

public static readonly DependencyProperty PointerTypeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RangeCapProperty

Declaration

public static readonly DependencyProperty RangeCapProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RangePointerStrokeProperty

Declaration

public static readonly DependencyProperty RangePointerStrokeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RangePointerStrokeThicknessProperty

Declaration

public static readonly DependencyProperty RangePointerStrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RangePointerVisibilityProperty

Declaration

public static readonly DependencyProperty RangePointerVisibilityProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

RangeStartProperty

Using a DependencyProperty as the backing store for RangeStart. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty RangeStartProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

StepFrequencyProperty

Declaration

public static readonly DependencyProperty StepFrequencyProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolPointerBorderBrushProperty

Declaration

public static readonly DependencyProperty SymbolPointerBorderBrushProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolPointerBorderThicknessProperty

Declaration

public static readonly DependencyProperty SymbolPointerBorderThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolPointerHeightProperty

Using a DependencyProperty as the backing store for SymbolPointerHeight. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SymbolPointerHeightProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolPointerStrokeProperty

Declaration

public static readonly DependencyProperty SymbolPointerStrokeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolPointerTemplateProperty

Using a DependencyProperty as the backing store for SymbolPointerTemplate. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SymbolPointerTemplateProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolPointerVisibilityProperty

Declaration

public static readonly DependencyProperty SymbolPointerVisibilityProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolPointerWidthProperty

Using a DependencyProperty as the backing store for SymbolPointerWidth. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SymbolPointerWidthProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

SymbolProperty

Using a DependencyProperty as the backing store for Symbol. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty SymbolProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TailBorderBrushProperty

Declaration

public static readonly DependencyProperty TailBorderBrushProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TailLengthFactorProperty

Declaration

public static readonly DependencyProperty TailLengthFactorProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TailStrokeProperty

Declaration

public static readonly DependencyProperty TailStrokeProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TailStrokeThicknessProperty

Declaration

public static readonly DependencyProperty TailStrokeThicknessProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TimerProperty

Declaration

public static readonly DependencyProperty TimerProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

TimeValueProperty

Declaration

public static readonly DependencyProperty TimeValueProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ValueDiffProperty

Declaration

public static readonly DependencyProperty ValueDiffProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

ValueProperty

Using a DependencyProperty as the backing store for Value. This enables animation, styling, binding, etc...

Declaration

public static readonly DependencyProperty ValueProperty

Field Value

Type
Windows.UI.Xaml.DependencyProperty

Properties

AnimationDuration

Gets or sets value indicating animation duration for pointer.

Declaration

public double AnimationDuration { get; set; }

Property Value

Type	Description
System.Double	true if ; otherwise, false.

Remarks

AnimationDuration property is used to set animation duration for pointer. Its default value is 1.5.

Examples

        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.AnimationDuration = 1.5;
        }
    }
}

EnableAnimation

Gets or sets value indicating whether this element can be animated.

Declaration

public bool EnableAnimation { get; set; }

Property Value

Type	Description
System.Boolean	true if ; otherwise, false.

Remarks

EnableAnimation property is used to animate the movement of the pointer when the Value is of the pointer is changed. Its default value is true.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.EnableAnimation = false;
        }
    }
}

EnableDragging

Gets or sets a value indicating whether the pointer can be draggable or not.

Declaration

public bool EnableDragging { get; set; }

Property Value

Type	Description
System.Boolean	bool

Examples

var pointer = new CircularPointer();
pointer.EnableDragging = true;

KnobRadiusFactor

Gets or sets the knob radius factor of the needle pointer.

Declaration

public double KnobRadiusFactor { get; set; }

Property Value

Type	Description
System.Double	double

Remarks

This property used to change the radius of the needle pointer cap.

Examples

var pointer = new CircularPointer();
pointer.PointerType = PointerType.NeedlePointer;
pointer.KnobRadiusFactor = 0.3d;

KnobStroke

Gets or sets the knob border color.

Declaration

public Brush KnobStroke { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Brush

KnobStrokeThickness

Gets or sets the knob border thickness.

Declaration

public double KnobStrokeThickness { get; set; }

Property Value

Type	Description
System.Double	double

NeedleLengthFactor

Gets or sets the value which helps to calculate the NeedleLength of the CircularPointer.

Declaration

public double NeedleLengthFactor { get; set; }

Property Value

Type	Description
System.Double	double

Remarks

NeedleLengthFactor property is used to calculate the NeedleLength based on the size of the SfCircularGauge. Value of the property should reside between 0.1 and 1.0. The default value is 0.75.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.NeedleLengthFactor = 0.5;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

NeedlePointerStroke

Gets or sets the brush that describes the NeedlePointerStroke of the CircularPointer.

Declaration

public Brush NeedlePointerStroke { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Brush

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.NeedlePointerStroke = new SolidColorBrush(Colors.White);
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

NeedlePointerStrokeThickness

Gets or sets the thickness value of the NeedlePointer of the CircularPointer.

Declaration

public double NeedlePointerStrokeThickness { get; set; }

Property Value

Type	Description
System.Double	double

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.NeedlePointerStrokeThickness = 2;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

NeedlePointerType

Gets or sets the type of needle pointer.

Declaration

public NeedlePointerType NeedlePointerType { get; set; }

Property Value

Type	Description
NeedlePointerType	NeedlePointerType

Remarks

The type of needle pointer can be set by using NeedlePointerType property and it’s includes following option. Rectangle, Triangle,Tapered, and Arrow. Default value of NeedlePointerType property is NeedlePointerType.Rectangle.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;
namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.NeedlePointerType = NeedlePointerType.Triangle;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

NeedlePointerVisibility

Gets or sets user interface visibility of the NeedlePointer.

Declaration

public Visibility NeedlePointerVisibility { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Visibility	Visibility

Remarks

There are three types of pointers. While choosing a pointer using the PointerType property the other two pointers' visibility property will be set to Collapsed. Default value is Visible.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer needlePointer = new CircularPointer();
           needlePointer.Value = 80;
           needlePointer.PointerType = PointerType.NeedlePointer;
           needlePointer.NeedlePointerVisibility = Visibility.Collapsed;
           gauge.MainScale.Pointers.Add(needlePointer);
        }
    }
}

PointerCapDiameter

Gets or sets the PointerCapDiameter value that decides the size of the PointerCap of the NeedlePointer .

Declaration

public double PointerCapDiameter { get; set; }

Property Value

Type	Description
System.Double	double

Remarks

This property used to change the size of the NeedlePointer cap.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.PointerCapDiameter = 20;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

PointerCapStroke

Gets or sets the brush that describes the PointerCapStroke of the CircularPointer.

Declaration

public Brush PointerCapStroke { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Brush

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           pointer.PointerCapStroke = new SolidColorBrush(Colors.White);
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

PointerType

Gets or sets Type of the CircularPointer.

Declaration

public PointerType PointerType { get; set; }

Property Value

Type	Description
PointerType	PointerType

Remarks

There are three types of pointers. User can choose a pointer using the PointerType property. Options are 1. NeedlePointer (Default) 2. RangePointer 3. Symbolointer

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.NeedlePointer;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

RangeCap

Declaration

public RangeCap RangeCap { get; set; }

Property Value

Type
RangeCap

RangePointerStroke

Gets or sets the brush that describes the RangePointerStroke of the CircularPointer.

Declaration

public Brush RangePointerStroke { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Brush

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.RangePointer;
           pointer.RangePointerStroke = new SolidColorBrush(Colors.White);
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

RangePointerStrokeThickness

Gets or sets the thickness of the RangePointer of the CircularPointer.

Declaration

public double RangePointerStrokeThickness { get; set; }

Property Value

Type	Description
System.Double	double

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.RangePointer;
           pointer.RangePointerStrokeThickness = 10;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

RangePointerVisibility

Gets or sets user interface (UI) visibility of RangePointer.

Declaration

public Visibility RangePointerVisibility { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Visibility	Visibility

Remarks

There are three types of pointers. While choosing a pointer using the PointerType property the other two pointers' visibility property will be set to Collapsed. Default value is Visible.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer needlePointer = new CircularPointer();
           needlePointer.Value = 80;
           needlePointer.PointerType = PointerType.NeedlePointer;
           needlePointer.RangePointerVisibility = Visibility.Collapsed;
           gauge.MainScale.Pointers.Add(needlePointer);
        }
    }
}

RangeStart

Declaration

public double RangeStart { get; set; }

Property Value

Type
System.Double

StepFrequency

Gets or sets the snap value to the marker or needle pointer. While dragging the pointer, it will move to next value based on step frequency value. Default value is 0.

Declaration

public double StepFrequency { get; set; }

Property Value

Type
System.Double

Remarks

To drag with step frequency value, enable dragging support for pointer.

Symbol

Gets or sets the Symbol value that decides the shape of the SymbolPointer .

Declaration

public Symbol Symbol { get; set; }

Property Value

Type	Description
Symbol	double

Remarks

This property used to change the symbol of the SymbolPointer.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.SymbolPointer;
           pointer.Symbol = Symbol.Ellipse;
           pointer.SymbolPointerHeight = 20;
           pointer.SymbolPointerWidth = 20;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

SymbolPointerBorderBrush

Gets or sets the brush that describes the SymbolPointerBorderBrush of the CircularPointer.

Declaration

public Brush SymbolPointerBorderBrush { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Brush

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.SymbolPointer;
           pointer.SymbolPointerStroke = new SolidColorBrush(Colors.White);
           pointer.SymbolPointerBorderBrush = new SolidColorBrush(Colors.Black);
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

SymbolPointerBorderThickness

Gets or sets the thickness of SymbolPointerBorder of the CircularPointer.

Declaration

public double SymbolPointerBorderThickness { get; set; }

Property Value

Type	Description
System.Double	Double

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.SymbolPointer;
           pointer.SymbolPointerStroke = new SolidColorBrush(Colors.White);
           pointer.SymbolPointerBorderThickness = 2;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

SymbolPointerHeight

Gets or sets the SymbolPointerHeight value that decides the size of the SymbolPointer .

Declaration

public double SymbolPointerHeight { get; set; }

Property Value

Type	Description
System.Double	double

Remarks

This property used to change the size of the SymbolPointer.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.SymbolPointer;
           pointer.SymbolPointerHeight = 20;
           pointer.SymbolPointerWidth = 20;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

SymbolPointerStroke

Gets or sets the brush that describes the SymbolPointerStroke of the CircularPointer.

Declaration

public Brush SymbolPointerStroke { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Media.Brush	Brush

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.SymbolPointer;
           pointer.SymbolPointerStroke = new SolidColorBrush(Colors.White);
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

SymbolPointerTemplate

Gets or sets the template for the custom symbol for the SymbolPointer.

Declaration

public DataTemplate SymbolPointerTemplate { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.DataTemplate	DataTemplate

Remarks

SymbolPointerTemplate will get applied when the Symbol property of the CircularPointer is set to Custom.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.SymbolPointer;
           pointer.Symbol = Symbol.Custom;
           pointer.SymbolPointerTemplate = Resources["star"];
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

SymbolPointerVisibility

Gets or sets the user interface (UI) visibility of SymbolPointer.

Declaration

public Visibility SymbolPointerVisibility { get; set; }

Property Value

Type	Description
Windows.UI.Xaml.Visibility	Visibility

Remarks

There are three types of pointers. While choosing a pointer using the PointerType property the other two pointers' visibility property will be set to Collapsed. Default value is Visible.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer needlePointer = new CircularPointer();
           needlePointer.Value = 80;
           needlePointer.PointerType = PointerType.NeedlePointer;
           needlePointer.SymbolPointerVisibility = Visibility.Collapsed;
           gauge.MainScale.Pointers.Add(needlePointer);
        }
    }
}

SymbolPointerWidth

Gets or sets the SymbolPointerWidth value that decides the size of the SymbolPointer .

Declaration

public double SymbolPointerWidth { get; set; }

Property Value

Type	Description
System.Double	double

Remarks

This property used to change the size of the SymbolPointer.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer pointer = new CircularPointer();
           pointer.Value = 80;
           pointer.PointerType = PointerType.SymbolPointer;
           pointer.SymbolPointerHeight = 20;
           pointer.SymbolPointerWidth = 20;
           gauge.MainScale.Pointers.Add(pointer);
        }
    }
}

TailBorderBrush

Declaration

public Brush TailBorderBrush { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

TailLengthFactor

Declaration

public double TailLengthFactor { get; set; }

Property Value

Type
System.Double

TailStroke

Declaration

public Brush TailStroke { get; set; }

Property Value

Type
Windows.UI.Xaml.Media.Brush

TailStrokeThickness

Declaration

public double TailStrokeThickness { get; set; }

Property Value

Type
System.Double

Value

Gets or sets the Value that decides the position of the CircularPointer in the CircularScale.

Declaration

public double Value { get; set; }

Property Value

Type	Description
System.Double	double

Remarks

Value property is one of the most important property. Based on the Value property pointer has been positioned on the CircularScale. Value should resides between the start and end value of the scale. If the value of this property is less than StartValue of the CircularScale, then the StartValue of the CircularScale is set to the Value of the pointer. Similarly EndValue of the CircularScale is set to the Value of the pointer when Value is greater that EndValue of the scale.

Examples

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using Windows.Foundation;
using Windows.Foundation.Collections;
using Windows.UI.Xaml;
using Windows.UI.Xaml.Controls;
using Windows.UI.Xaml.Controls.Primitives;
using Windows.UI.Xaml.Data;
using Windows.UI.Xaml.Input;
using Windows.UI.Xaml.Media;
using Windows.UI.Xaml.Navigation;
using Common;
using Syncfusion.UI.Xaml.Gauges;

namespace GaugeWinRTSamples
{
    public sealed partial class GaugePosition :SampleView
    {
        public GaugePosition()
        {
           InitializeComponent();
           SfCircularGauge gauge = new SfCircularGauge();
           CircularPointer needlePointer = new CircularPointer();
           needlePointer.Value = 80;
           needlePointer.PointerType = PointerType.NeedlePointer;
           gauge.MainScale.Pointers.Add(needlePointer);
        }
    }
}

Methods

add_PointerPositionChanged(CircularPointer.PointerPositionChangedEventHandler)

Declaration

public void add_PointerPositionChanged(CircularPointer.PointerPositionChangedEventHandler value)

Parameters

Type	Name	Description
CircularPointer.PointerPositionChangedEventHandler	value

Dispose()

Declaration

public void Dispose()

MeasureOverride(Size)

Measures the size in layout required for child elements.

Declaration

protected override Size MeasureOverride(Size availableSize)

Parameters

Type	Name	Description
Windows.Foundation.Size	availableSize	This size give to child elements

Returns

Type	Description
Windows.Foundation.Size	Return child element size

OnApplyTemplate()

Declaration

protected override void OnApplyTemplate()

OnPointerPressed(PointerRoutedEventArgs)

Declaration

protected override void OnPointerPressed(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e

OnPointerReleased(PointerRoutedEventArgs)

Declaration

protected override void OnPointerReleased(PointerRoutedEventArgs e)

Parameters

Type	Name	Description
Windows.UI.Xaml.Input.PointerRoutedEventArgs	e

remove_PointerPositionChanged(CircularPointer.PointerPositionChangedEventHandler)

Declaration

public void remove_PointerPositionChanged(CircularPointer.PointerPositionChangedEventHandler value)

Parameters

Type	Name	Description
CircularPointer.PointerPositionChangedEventHandler	value

Events

PointerPositionChanged

Occurs when pointer position is changed

Declaration

public event CircularPointer.PointerPositionChangedEventHandler PointerPositionChanged

Event Type

Type
CircularPointer.PointerPositionChangedEventHandler

ValueChangeCompleted

Called when the user is done selecting a new value of the pointer by dragging.

Declaration

public event EventHandler<PointerValueChangedEventArgs> ValueChangeCompleted

Event Type

Type
System.EventHandler<PointerValueChangedEventArgs>

Remarks

This event shouldn't be used to update the pointer value (use PointerPositionChanged event for that), but rather to know when the user has completed selecting a new value by ending a drag.

See Also

EnableDragging

ValueChangeStarted

Called when the user starts selecting a new value of pointer by dragging.

Declaration

public event EventHandler<PointerValueChangedEventArgs> ValueChangeStarted

Event Type

Type
System.EventHandler<PointerValueChangedEventArgs>

Remarks

This event shouldn't be used to update the pointer value (use PointerPositionChanged event for that), but rather to be notified when the user has started selecting a new value by starting a drag. The value passed will be the last value that the pointer had before the change began.

See Also

EnableDragging

ValueChanging

Called during a drag when the user is selecting before a new value for the pointer by dragging.

Declaration

public event EventHandler<PointerValueChangingEventArgs> ValueChanging

Event Type

Type
System.EventHandler<PointerValueChangingEventArgs>

Remarks

This event shouldn't be used to update the pointer value (use PointerPositionChanged event for that), but rather it will show the oldvalue and newvalue of the pointer.

See Also

EnableDragging

Implements

System.IDisposable

Extension Methods

DateTimeExtension.ToDateTime(Object)