Documentation

Class BaseGanttViewTimelineBehavior

Inheritance
System.Object
BaseGanttViewTimelineBehavior
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class BaseGanttViewTimelineBehavior

Constructors

BaseGanttViewTimelineBehavior()

Declaration
public BaseGanttViewTimelineBehavior()

Properties

AdjustedTimelineEnd

Gets a value which enlarges the timeline end so only whole cells would be displayed.

Declaration
public virtual DateTime AdjustedTimelineEnd { get; }
Property Value
System.DateTime

AdjustedTimelineStart

Gets a value which enlarges the timeline start so only whole cells would be displayed.

Declaration
public virtual DateTime AdjustedTimelineStart { get; }
Property Value
System.DateTime

GraphicalViewElement

Gets the gantt graphical view this behavior is associated with.

Declaration
public GanttViewGraphicalViewElement GraphicalViewElement { get; }
Property Value
GanttViewGraphicalViewElement

RangesMinWidths

Gets a dictionary where the key is a time ranges and the value is the minimum width for a single item in the timeline view for that time range.

Declaration
protected Dictionary<TimeRange, int> RangesMinWidths { get; }
Property Value
System.Collections.Generic.Dictionary<TimeRange, System.Int32>

TimelineLowerItemFormat

Gets or sets the format for the lower row items of the timeline.

Declaration
public virtual string TimelineLowerItemFormat { get; set; }
Property Value
System.String

The timeline lower item format.

TimelineUpperItemFormat

Gets or sets the format for the upper row items of the timeline.

Declaration
public virtual string TimelineUpperItemFormat { get; set; }
Property Value
System.String

The timeline upper item format.

Methods

BuildTimelineDataItems(TimeRange)

Gets a list of GanttViewTimelineDataItems that will be shown in the timeline.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItems(TimeRange range)
Parameters
TimeRange range

Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForDayHalfHoursRange()

Returns a list of GanttViewTimelineDataItems for day range with half hours for the sub-items.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForDayHalfHoursRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForDayQuarterHoursRange()

Returns a list of GanttViewTimelineDataItems for da range with quarter hours for the sub-items.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForDayQuarterHoursRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForDayRange()

Returns a list of GanttViewTimelineDataItems for day range.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForDayRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForHourRange()

Returns a list of GanttViewTimelineDataItems for hour range.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForHourRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForMonthRange()

Returns a list of GanttViewTimelineDataItems for month range.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForMonthRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForWeekRange()

Returns a list of GanttViewTimelineDataItems for week range.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForWeekRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForYearHalvesRange()

Returns a list of GanttViewTimelineDataItems for year range with half years for the sub-items.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForYearHalvesRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForYearQuartersRange()

Returns a list of GanttViewTimelineDataItems for year range with quarter years for the sub-items.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForYearQuartersRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

BuildTimelineDataItemsForYearRange()

Returns a list of GanttViewTimelineDataItems for year range.

Declaration
public virtual IList<GanttViewTimelineDataItem> BuildTimelineDataItemsForYearRange()
Returns
System.Collections.Generic.IList<GanttViewTimelineDataItem>

CreateElement()

Creates the element.

Declaration
public virtual GanttViewTimelineCellElement CreateElement()
Returns
GanttViewTimelineCellElement

FillRangesMinWidths()

Fills the RangesMinWidths property (dictionary) with the minimum width for each TimeRange. These values are used when AutomaticTimelineTimeRange is se to true.

Declaration
public virtual void FillRangesMinWidths()

GetAutoTimeRange(TimeRange, Boolean)

Gets a new time range based on the current state of the RadGanttView. If no change is needed returns the value of the input range.

Declaration
public virtual TimeRange GetAutoTimeRange(TimeRange currentRange, bool zoomIn)
Parameters
TimeRange currentRange

The current TimeRange.
System.Boolean zoomIn

Indicates whether a zoom-in or a zoom-out operation is performed.
Returns
TimeRange

A value of the TimeRange enumeration. If no change is needed returns the input range.

GetTimelineBottomElementText(GanttViewTimelineDataItem, Int32)

Gets the timeline lower element text for the specified index.

Declaration
public virtual string GetTimelineBottomElementText(GanttViewTimelineDataItem item, int index)
Parameters
GanttViewTimelineDataItem item

The timeline item.
System.Int32 index

The index of the lower element.
Returns
System.String

GetTimelineCellInfoForDayHalfHoursRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForDayHalfHoursRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForDayQuarterHoursRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForDayQuarterHoursRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForDayRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForDayRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForHourRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForHourRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForItem(GanttViewTimelineDataItem, TimeRange)

Gets the number of cells and optionally a start index to be displayed for the given timeline data item and time range.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForItem(GanttViewTimelineDataItem item, TimeRange timeRange)
Parameters
GanttViewTimelineDataItem item

The data item for which the cell info is calculated.
TimeRange timeRange

The time range for which the cell info is calculated.
Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForMonthRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForMonthRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForWeekRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForWeekRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForYearHalvesRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForYearHalvesRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForYearQuartersRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForYearQuartersRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineCellInfoForYearRange(GanttViewTimelineDataItem)

Returns the number of cells and optionally a start index to be displayed for the given timeline data item.

Declaration
public virtual GanttTimelineCellsInfo GetTimelineCellInfoForYearRange(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

Returns
GanttTimelineCellsInfo

GetTimelineTopElementText(GanttViewTimelineDataItem)

Gets the time line top element text.

Declaration
public virtual string GetTimelineTopElementText(GanttViewTimelineDataItem item)
Parameters
GanttViewTimelineDataItem item

The item to get text for.
Returns
System.String

WeekNumber(DateTime)

Gets the week number for the given date using ISO8601 stadard.

Declaration
public virtual int WeekNumber(DateTime date)
Parameters
System.DateTime date

The date.
Returns
System.Int32

Extension Methods