Not logged in▾
Log In Register
Forgot Password Resend Validation E-mail
In This Article

CircularPointerCap Class

Namespace:
ActiproSoftware.Windows.Controls.Gauge
Assembly:
ActiproSoftware.Gauge.Wpf.dll

Represents a cap pointer for use in a CircularGauge.

public class CircularPointerCap : CircularPointerBase, ILogicalParent, IVisualParent
Inheritance:
object Visual UIElement FrameworkElement GaugeElement PointerBase CircularPointerBase object
Implements:
ILogicalParent IVisualParent

Remarks

For detailed documentation on this control's features and how to use them, please see the Gauge documentation topics.

Constructors

CircularPointerCap()

Initializes an instance of the class.

public CircularPointerCap()

Properties

CanRotate

Gets and sets a value indicating whether the circular pointer cap should be rotated to point to the associated value. This is a dependency property.

public bool CanRotate { get; set; }

Property Value

bool:

true if the pointer cap should rotate; otherwise, false. The default value is false.

CapType

Gets or sets the type of cap rendered. This is a dependency property.

public PointerCapType CapType { get; set; }

Property Value

PointerCapType:

The type of cap rendered. The default value is PointerCapType.CircleConcave.

Geometry

Gets or sets the custom geometry. This is a dependency property.

public Geometry Geometry { get; set; }

Property Value

Geometry:

A custom geometry. The default value is null.

Remarks

This property is only used when CapType is set to PointerCapType.CustomGeometry.

ImageSource

Gets or sets the source of a custom image. This is a dependency property.

public ImageSource ImageSource { get; set; }

Property Value

ImageSource:

The image source. The default value is null.

Remarks

This property is only used when CapType is set to PointerCapType.CustomImage.

IsBackgroundEffectEnabled

Gets and sets a value indicating whether a special effect should be rendered for the background of the cap. This is a dependency property.

public bool IsBackgroundEffectEnabled { get; set; }

Property Value

bool:

true if the background effect is enabled; otherwise, false. The default value is true.

Methods

OnCreateAutomationPeer()

Creates an appropriate AutomationPeer for this control as part of the WPF infrastructure.

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

null.

OnRender(DrawingContext)

When overridden in a derived class, participates in rendering operations that are directed by the layout system. The rendering instructions for this element are not used directly when this method is invoked, and are instead preserved for later asynchronous use by layout and drawing.

protected override void OnRender(DrawingContext drawingContext)
Parameter Type Description
drawingContext DrawingContext

The drawing instructions for a specific element. This context is provided to the layout system.

Fields

CanRotateProperty

Identifies the CanRotate dependency property. This field is read-only.

public static readonly DependencyProperty CanRotateProperty

CapTypeProperty

Identifies the CapType dependency property. This field is read-only.

public static readonly DependencyProperty CapTypeProperty

GeometryProperty

Identifies the Geometry dependency property. This field is read-only.

public static readonly DependencyProperty GeometryProperty

ImageSourceProperty

Identifies the ImageSource dependency property. This field is read-only.

public static readonly DependencyProperty ImageSourceProperty

IsBackgroundEffectEnabledProperty

Identifies the IsBackgroundEffectEnabled dependency property. This field is read-only.

public static readonly DependencyProperty IsBackgroundEffectEnabledProperty

Inherited Members