Class IntervalBase

Base class for all interval types.

Inheritance
System.Object
IntervalBase
CenturyInterval
DayInterval
DecadeInterval
HourInterval
MillisecondInterval
MinuteInterval
MonthInterval
QuarterInterval
SecondInterval
WeekInterval
YearInterval
Namespace: Telerik.Windows.Controls.TimeBar
Assembly: Telerik.Windows.Controls.DataVisualization.dll

Syntax

public abstract class IntervalBase : DependencyObject

Constructors

IntervalBase()

Initializes a new instance of the IntervalBase class.

Declaration
protected IntervalBase()

Fields

CurrentIntervalSpanProperty

Identifies the CurrentIntervalSpan dependency property.

Declaration
public static readonly DependencyProperty CurrentIntervalSpanProperty
Field Value
System.Windows.DependencyProperty

IntervalSpansProperty

Identifies the IntervalSpans dependency property.

Declaration
public static readonly DependencyProperty IntervalSpansProperty
Field Value
System.Windows.DependencyProperty

Properties

CurrentIntervalSpan

Gets the current number of smallest interval periods that one interval item spans.

Declaration
public int CurrentIntervalSpan { get; }
Property Value
System.Int32

The current number of smallest interval periods that one interval item spans.

FormatterProvider

Gets or sets an object that controls the formatting of the interval labels.

Declaration
public IIntervalFormatterProvider FormatterProvider { get; set; }
Property Value
IIntervalFormatterProvider

The formatter provider.

Formatters

Gets a collection of formatters used to convert System.DateTime objects to specific strings.

Declaration
public abstract Func<DateTime, string>[] Formatters { get; }
Property Value
System.Func<System.DateTime, System.String>[]

A collection of formatters.
Remarks

The Formatters collection is used when CurrentIntervalSpan equals 1; otherwise, the IntervalSpanFormatters collection is used.

IntervalSpanFormatters

Gets a collection of formatters used to convert System.DateTime objects to specific strings.

Declaration
public virtual Func<DateTime, string>[] IntervalSpanFormatters { get; }
Property Value
System.Func<System.DateTime, System.String>[]

A collection of formatters.
Remarks

The Formatters collection is used when CurrentIntervalSpan equals 1; otherwise, the IntervalSpanFormatters collection is used.

IntervalSpans

Gets or sets a collection of numbers of smallest interval periods that one interval item can span.

Declaration
public IntervalSpanCollection IntervalSpans { get; set; }
Property Value
IntervalSpanCollection

A collection of numbers of smallest interval periods that one interval item can span.

MinimumPeriodLength

Gets the smallest interval period.

Declaration
public abstract TimeSpan MinimumPeriodLength { get; }
Property Value
System.TimeSpan

The smallest interval period.

Methods

ExtractIntervalStart(DateTime)

Extracts the interval start from a specified System.DateTime object.

Declaration
public abstract DateTime ExtractIntervalStart(DateTime date)
Parameters
System.DateTime date

The System.DateTime object.
Returns
System.DateTime

The interval start date.

IncrementByCurrentInterval(DateTime)

Increments a specified System.DateTime object by the CurrentIntervalSpan number of smallest interval periods.

Declaration
public DateTime IncrementByCurrentInterval(DateTime date)
Parameters
System.DateTime date

The DateTime object.
Returns
System.DateTime

The incremented System.DateTime object.

IncrementByInterval(DateTime, Int32)

Increments a specified System.DateTime object by a specified number of MinimumPeriodLengths.

Declaration
public abstract DateTime IncrementByInterval(DateTime date, int intervalSpan)
Parameters
System.DateTime date

The DateTime object.
System.Int32 intervalSpan

The number of MinimumPeriodLengths.
Returns
System.DateTime

The incremented System.DateTime object.

Extension Methods