Class
IntervalBase

Base class for all interval types.

Definition

Namespace:Telerik.Windows.Controls.TimeBar

Assembly:Telerik.Windows.Controls.DataVisualization.dll

Syntax:

cs-api-definition
public abstract class IntervalBase : DependencyObject

Inheritance: objectIntervalBase

Derived Classes: CenturyIntervalDayIntervalDecadeIntervalHourIntervalMillisecondIntervalMinuteIntervalMonthIntervalQuarterIntervalSecondIntervalWeekIntervalYearInterval

Constructors

IntervalBase()

Initializes a new instance of the IntervalBase class.

Declaration

cs-api-definition
protected IntervalBase()

Fields

CurrentIntervalSpanProperty

Identifies the CurrentIntervalSpan dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty CurrentIntervalSpanProperty

Field Value

DependencyProperty

IntervalSpansProperty

Identifies the IntervalSpans dependency property.

Declaration

cs-api-definition
public static readonly DependencyProperty IntervalSpansProperty

Field Value

DependencyProperty

Properties

CurrentIntervalSpan

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

Declaration

cs-api-definition
public int CurrentIntervalSpan { get; }

Property Value

int

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

cs-api-definition
public IIntervalFormatterProvider FormatterProvider { get; set; }

Property Value

IIntervalFormatterProvider

The formatter provider.

Formatters

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

Declaration

cs-api-definition
public abstract Func<DateTime, string>[] Formatters { get; }

Property Value

Func<DateTime, 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 DateTime objects to specific strings.

Declaration

cs-api-definition
public virtual Func<DateTime, string>[] IntervalSpanFormatters { get; }

Property Value

Func<DateTime, 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

cs-api-definition
[TypeConverter(typeof(IntervalSpansConverter))]
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

cs-api-definition
public abstract TimeSpan MinimumPeriodLength { get; }

Property Value

TimeSpan

The smallest interval period.

Methods

ExtractIntervalStart(DateTime)

Extracts the interval start from a specified DateTime object.

Declaration

cs-api-definition
public abstract DateTime ExtractIntervalStart(DateTime date)

Parameters

date

DateTime

The DateTime object.

Returns

DateTime

The interval start date.

IncrementByCurrentInterval(DateTime)

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

Declaration

cs-api-definition
public DateTime IncrementByCurrentInterval(DateTime date)

Parameters

date

DateTime

The DateTime object.

Returns

DateTime

The incremented DateTime object.

IncrementByInterval(DateTime, int)

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

Declaration

cs-api-definition
public abstract DateTime IncrementByInterval(DateTime date, int intervalSpan)

Parameters

date

DateTime

The DateTime object.

intervalSpan

int

The number of MinimumPeriodLengths.

Returns

DateTime

The incremented DateTime object.