Class ShapeAnnotation
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.UI.Xaml.Charts
Assembly: Syncfusion.SfChart.WPF.dll
Syntax
public abstract class ShapeAnnotation : SingleAnnotation, ICloneable
Constructors
ShapeAnnotation()
Constructor
Declaration
public ShapeAnnotation()
Fields
CanDragProperty
The DependencyProperty for CanDrag property.
Declaration
public static readonly DependencyProperty CanDragProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
CanResizeProperty
The DependencyProperty for CanResize property.
Declaration
public static readonly DependencyProperty CanResizeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
DraggingModeProperty
The DependencyProperty for DraggingMode property.
Declaration
public static readonly DependencyProperty DraggingModeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
FillProperty
The DependencyProperty for Fill property.
Declaration
public static readonly DependencyProperty FillProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
HorizontalTextAlignmentProperty
The DependencyProperty for HorizontalTextAlignment property.
Declaration
public static readonly DependencyProperty HorizontalTextAlignmentProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeDashArrayProperty
The DependencyProperty for StrokeDashArray property.
Declaration
public static readonly DependencyProperty StrokeDashArrayProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeDashCapProperty
The DependencyProperty for StrokeDashCap property.
Declaration
public static readonly DependencyProperty StrokeDashCapProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeDashOffsetProperty
The DependencyProperty for StrokeDashOffset property.
Declaration
public static readonly DependencyProperty StrokeDashOffsetProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeEndLineCapProperty
The DependencyProperty for StrokeEndLineCap property.
Declaration
public static readonly DependencyProperty StrokeEndLineCapProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeLineJoinProperty
The DependencyProperty for StrokeLineJoin property.
Declaration
public static readonly DependencyProperty StrokeLineJoinProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeMiterLimitProperty
The DependencyProperty for StrokeMiterLimit property.
Declaration
public static readonly DependencyProperty StrokeMiterLimitProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeProperty
The DependencyProperty for Stroke property.
Declaration
public static readonly DependencyProperty StrokeProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeStartLineCapProperty
The DependencyProperty for StrokeStartLineCap property.
Declaration
public static readonly DependencyProperty StrokeStartLineCapProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
StrokeThicknessProperty
The DependencyProperty for StrokeThickness property.
Declaration
public static readonly DependencyProperty StrokeThicknessProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
VerticalTextAlignmentProperty
The DependencyProperty for VerticalTextAlignment property.
Declaration
public static readonly DependencyProperty VerticalTextAlignmentProperty
Field Value
Type |
---|
System.Windows.DependencyProperty |
x2
Declaration
protected double x2
Field Value
Type |
---|
System.Double |
X2Property
The DependencyProperty for X2 property.
Declaration
public static readonly DependencyProperty X2Property
Field Value
Type |
---|
System.Windows.DependencyProperty |
y2
Declaration
protected double y2
Field Value
Type |
---|
System.Double |
Y2Property
The DependencyProperty for Y2 property.
Declaration
public static readonly DependencyProperty Y2Property
Field Value
Type |
---|
System.Windows.DependencyProperty |
Properties
CanDrag
Gets or sets a value indicating whether dragging is enabled for the annotation.
Declaration
public bool CanDrag { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | If |
CanResize
Gets or sets a value indicating whether resizing is enabled for the annotation.
Declaration
public bool CanResize { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | If |
DraggingMode
Gets or sets the dragging direction for the annotation.
Declaration
public AxisMode DraggingMode { get; set; }
Property Value
Type | Description |
---|---|
AxisMode |
|
Fill
Gets or sets the fill color of the ShapeAnnotation.
Declaration
public Brush Fill { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The System.Windows.Media.Brush value. |
HorizontalTextAlignment
Gets or sets the horizontal text alignment.
Declaration
public HorizontalAlignment HorizontalTextAlignment { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.HorizontalAlignment | The System.Windows.HorizontalAlignment value. |
Stroke
Gets or sets the stroke for the annotation.
Declaration
public Brush Stroke { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.Brush | The System.Windows.Media.Brush value. |
StrokeDashArray
Gets or sets the stroke dash array for the annotation stroke.
Declaration
public DoubleCollection StrokeDashArray { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.DoubleCollection | System.Windows.Media.DoubleCollection. |
StrokeDashCap
Gets or sets the stroke dash cap for the stroke.
Declaration
public PenLineCap StrokeDashCap { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.PenLineCap | System.Windows.Media.PenLineCap. |
StrokeDashOffset
Gets or sets the stroke dash offset for the annotation.
Declaration
public double StrokeDashOffset { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The double value. |
StrokeEndLineCap
Gets or sets the end line cap for the stroke.
Declaration
public PenLineCap StrokeEndLineCap { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.PenLineCap | System.Windows.Media.PenLineCap. |
StrokeLineJoin
Gets or sets the stroke line join for the stroke of the shape.
Declaration
public PenLineJoin StrokeLineJoin { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.PenLineJoin | System.Windows.Media.PenLineJoin |
StrokeMiterLimit
Gets or sets a limit on the ratio of the miter length to half the StrokeThickness of the shape.
Declaration
public double StrokeMiterLimit { get; set; }
Property Value
Type |
---|
System.Double |
StrokeStartLineCap
Gets or sets the start line cap for the stroke.
Declaration
public PenLineCap StrokeStartLineCap { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.Media.PenLineCap | System.Windows.Media.PenLineCap. |
StrokeThickness
Gets or sets the stroke thickness.
Declaration
public double StrokeThickness { get; set; }
Property Value
Type |
---|
System.Double |
VerticalTextAlignment
Gets or sets the vertical alignment of the text description in ShapeAnnotation.
Declaration
public VerticalAlignment VerticalTextAlignment { get; set; }
Property Value
Type | Description |
---|---|
System.Windows.VerticalAlignment | The System.Windows.VerticalAlignment property. |
X2
Gets or sets the X2 value for the ShapeAnnotation.
Declaration
public object X2 { get; set; }
Property Value
Type |
---|
System.Object |
Y2
Gets or sets the Y2 value for the ShapeAnnotation.
Declaration
public object Y2 { get; set; }
Property Value
Type |
---|
System.Object |
Methods
CloneAnnotation(Annotation)
Declaration
protected override DependencyObject CloneAnnotation(Annotation annotation)
Parameters
Type | Name | Description |
---|---|---|
Annotation | annotation |
Returns
Type |
---|
System.Windows.DependencyObject |
Overrides
GetTextPosition(Size, Point)
Declaration
protected Point GetTextPosition(Size desiredSize, Point originalPosition)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Size | desiredSize | |
System.Windows.Point | originalPosition |
Returns
Type |
---|
System.Windows.Point |
GetTextPosition(Size, Point, Size)
Declaration
protected virtual Point GetTextPosition(Size desiredSize, Point originalPosition, Size textSize)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Size | desiredSize | |
System.Windows.Point | originalPosition | |
System.Windows.Size | textSize |
Returns
Type |
---|
System.Windows.Point |
OnDragCompleted(AnnotationDragCompletedEventArgs)
Declaration
protected virtual void OnDragCompleted(AnnotationDragCompletedEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
AnnotationDragCompletedEventArgs | args |
OnDragDelta(AnnotationDragDeltaEventArgs)
Declaration
protected virtual void OnDragDelta(AnnotationDragDeltaEventArgs args)
Parameters
Type | Name | Description |
---|---|---|
AnnotationDragDeltaEventArgs | args |
OnDragStarted(EventArgs)
Declaration
protected virtual void OnDragStarted(EventArgs args)
Parameters
Type | Name | Description |
---|---|---|
System.EventArgs | args |
SetBindings()
Declaration
protected override void SetBindings()
Overrides
UpdateAnnotation()
Updates the annotation.
Declaration
public override void UpdateAnnotation()
Overrides
Events
DragCompleted
Occurs when annotation drag is completed.
Declaration
public event EventHandler<AnnotationDragCompletedEventArgs> DragCompleted
Event Type
Type |
---|
System.EventHandler<AnnotationDragCompletedEventArgs> |
DragDelta
Occurs when annotation dragging.
Declaration
public event EventHandler<AnnotationDragDeltaEventArgs> DragDelta
Event Type
Type |
---|
System.EventHandler<AnnotationDragDeltaEventArgs> |
DragStarted
Occurs when annotation drag is started.
Declaration
public event EventHandler DragStarted
Event Type
Type |
---|
System.EventHandler |