Dundas Chart for Windows Forms
Interval Property
See Also  Example Send comments on this topic.
DundasWinChart Assembly > Dundas.Charting.WinControl Namespace > Cursor Class : Interval Property


Gets or sets the cursor movement interval.
Cursor movement interval.

Syntax

Visual Basic (Declaration)  
Public Property Interval As Double
Visual Basic (Usage) Copy Code
Dim instance As Cursor
Dim value As Double
 
instance.Interval = value
 
value = instance.Interval
C#  
public double Interval {get; set;}

Return Value

A double value representing the cursor interval.

Example

C# Copy Code
using Dundas.Charting.WinControl;
  ...
// Enable range selection and cursor user interface, respectively.
chart1.ChartAreas["Default"].CursorX.UserEnabled = true;
chart1.ChartAreas["Default"].CursorX.UserSelection = true;

// Set the interval property for 1 week.
chart1.ChartAreas["Default"].CursorX.Interval = 1;
chart1.ChartAreas["Default"].CursorX.IntervalType = DateTimeIntervalType.Weeks;

// Set the offset to 6 days (Sunday is considered the first day,
// so an offset of 6 days specifies Saturdays).
chart1.ChartAreas["Default"].CursorX.IntervalOffset = 6;
chart1.ChartAreas["Default"].CursorX.IntervalOffsetType = DateTimeIntervalType.Days;
Visual Basic Copy Code
Imports Dundas.Charting.WinControl
   ...
' Enable range selection and cursor user interface, respectively.
chart1.ChartAreas("Default").CursorX.UserEnabled = True
chart1.ChartAreas("Default").CursorX.UserSelection = True

' Set the interval property for 1 week.
chart1.ChartAreas("Default").CursorX.Interval = 1
chart1.ChartAreas("Default").CursorX.IntervalType = DateTimeIntervalType.Weeks

' Set the offset to 6 days (Sunday is considered the first day,
' so an offset of 6 days specifies Saturdays).
chart1.ChartAreas("Default").CursorX.IntervalOffset = 6
chart1.ChartAreas("Default").CursorX.IntervalOffsetType = DateTimeIntervalType.Days

Remarks

This property determines how often and where a cursor can be drawn by a user, as well as where the beginning and end points of a range selection can be drawn.  A value of zero (the default) means that a cursor or range selection can be drawn anywhere within a chart area.  A non-zero value means that the cursor or beginning/end points of a selected range will only be drawn at the specified interval when set by user-interaction.

The unit of measurement is determined by the IntervalType property.

This property can also be used in conjunction with the IntervalOffset property, which allows for an offset from the specified interval.  For example, to allow a cursor to only be displayed every Saturday an interval of 1 week should be specified, along with an interval offset of 6 days (in .NET Sunday is considered the first day of the week).

If the cursor user interface is enabled (via the UserEnabled property), and the mouse is clicked inside a chart area the position of the cursor will be set to the nearest allowable location. 

IMPORTANT: The Interval property has no effect when setting the position of a cursor or range selection programmatically.

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2009 All Rights Reserved.