Class RadGanttViewElement

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
UIItemBase
LightVisualElement
RadGanttViewElement
Inherited Members
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 RadGanttViewElement : LightVisualElement, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IComponent, IDisposable, IBindableComponent, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IPrimitiveElement, IShapedElement, IFillElement, IBorderElement, IBoxStyle, IBoxElement, IDrawFillElement, IImageElement, ITextPrimitive, ITextProvider

Constructors

RadGanttViewElement()

Initializes a new instance of the RadGanttViewElement class.

Declaration
public RadGanttViewElement()

Fields

HeaderHeightProperty

Identifies the HeaderHeight dependency property.

Declaration
public static RadProperty HeaderHeightProperty
Field Value
RadProperty

ItemHeightProperty

Identifies the ItemHeight dependency property.

Declaration
public static RadProperty ItemHeightProperty
Field Value
RadProperty

ItemSpacingProperty

Identifies the ItemSpacing dependency property.

Declaration
public static RadProperty ItemSpacingProperty
Field Value
RadProperty

MinimumLinkLengthProperty

Identifies the MinimumLinkLength dependency property.

Declaration
public static RadProperty MinimumLinkLengthProperty
Field Value
RadProperty

MinimumTaskWidthProperty

Identifies the MinimumTaskWidth dependency property.

Declaration
public static RadProperty MinimumTaskWidthProperty
Field Value
RadProperty

ReadOnlyProperty

Identifies the ReadOnly dependency property.

Declaration
public static RadProperty ReadOnlyProperty
Field Value
RadProperty

SplitterWidthProperty

Identifies the SplitterWidth dependency property.

Declaration
public static RadProperty SplitterWidthProperty
Field Value
RadProperty

Properties

ActiveEditor

Gets the active editor.

Declaration
public IValueEditor ActiveEditor { get; }
Property Value
IValueEditor

AllowDefaultContextMenu

Gets or sets a value indicating whether the default context menu may be shown.

Declaration
public bool AllowDefaultContextMenu { get; set; }
Property Value
System.Boolean

true if the default context menu may be shown; otherwise, false.

AllowSummaryEditing

Gets or sets a value indicating whether summary items are editable by the user or their value is auto-calculated from their sub items.

Declaration
public bool AllowSummaryEditing { get; set; }
Property Value
System.Boolean

BeginEditMode

Gets or sets the begin edit mode.

Declaration
public GanttViewBeginEditModes BeginEditMode { get; set; }
Property Value
GanttViewBeginEditModes

The begin edit mode.

BindingContext

Gets or sets the BindingContext for the object.

Declaration
public override BindingContext BindingContext { get; set; }
Property Value
System.Windows.Forms.BindingContext

Overrides

ChildMember

Gets or sets a property name which will be used to define a relation of the data items.

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

Columns

Gets the columns shown in the GanttViewTextViewElement.

Declaration
public GanttViewTextViewColumnCollection Columns { get; }
Property Value
GanttViewTextViewColumnCollection

The columns.

Comparer

Gets or sets the default sort Comparer for RadGanttView. The default comparer compares the items according to their start time.

Declaration
public IComparer<GanttViewDataItem> Comparer { get; set; }
Property Value
System.Collections.Generic.IComparer<GanttViewDataItem>

ContextMenu

Gets or sets the context menu.

Declaration
public virtual RadContextMenu ContextMenu { get; set; }
Property Value
RadContextMenu

The context menu.

CurrentColumn

Gets or sets the current column.

Declaration
public GanttViewTextViewColumn CurrentColumn { get; set; }
Property Value
GanttViewTextViewColumn

DataItemProvider

Gets the data item provider.

Declaration
public virtual GanttViewDataItemProvider DataItemProvider { get; }
Property Value
GanttViewDataItemProvider

The data item provider.

DataProvider

Declaration
public IGanttViewDataProvider DataProvider { get; set; }
Property Value
IGanttViewDataProvider

DataSource

Gets or sets the data source that the RadGanttView is displaying data for.

Declaration
public object DataSource { get; set; }
Property Value
System.Object

DisableEnsureItemVisibleHorizontal

Gets or sets a value indicating whether to disable ensure item visible horizontal.

Declaration
public bool DisableEnsureItemVisibleHorizontal { get; set; }
Property Value
System.Boolean

true if ensure item visible horizontal is disabled; otherwise, false.

DragDropService

Gets or sets the drag drop service.

Declaration
public GanttViewDragDropService DragDropService { get; set; }
Property Value
GanttViewDragDropService

The drag drop service.

EnableCustomPainting

Gets or sets a value indicating whether custom painting is enabled.

Declaration
public bool EnableCustomPainting { get; set; }
Property Value
System.Boolean

true if custom painting is enabled; otherwise, false.

EnableKineticScrolling

Gets or sets a value indicating whether the kinetic scrolling function is enabled.

Declaration
public bool EnableKineticScrolling { get; set; }
Property Value
System.Boolean

EndMember

Gets or sets a property name which will be used to extract the end of the data items.

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

FilterDescriptors

Gets the filter descriptors.

Declaration
public FilterDescriptorCollection FilterDescriptors { get; }
Property Value
FilterDescriptorCollection

The filter descriptors.

GanttViewBehavior

Gets or sets the gantt view behavior.

Declaration
public BaseGanttViewBehavior GanttViewBehavior { get; set; }
Property Value
BaseGanttViewBehavior

The gantt view behavior.

GraphicalViewElement

Gets the GanttViewGraphicalViewElement.

Declaration
public GanttViewGraphicalViewElement GraphicalViewElement { get; }
Property Value
GanttViewGraphicalViewElement

The graphical view element.

HeaderHeight

Gets or sets the height of the header row and the timeline container.

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

The height of the header.

IsDataBound

Gets a value indicating whether this instance is data bound.

Declaration
public bool IsDataBound { get; }
Property Value
System.Boolean

true if this instance is data bound; otherwise, false.

IsEditing

Gets a value indicating whether this instance is in edit mode.

Declaration
public bool IsEditing { get; }
Property Value
System.Boolean

true if this instance is in edit mode; otherwise, false.

IsInDesignMode

Gets or a value indicating whether the control is in design mode.

Declaration
public bool IsInDesignMode { get; }
Property Value
System.Boolean

ItemHeight

Gets or sets the height of the items.

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

The height of the item.

Items

Gets the collection of task items.

Declaration
public GanttViewDataItemCollection Items { get; }
Property Value
GanttViewDataItemCollection

The task items.

ItemSpacing

Gets or sets the item spacing.

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

The item spacing.

LinkDataMember

Gets or sets the name of the list or table in the data source from which the RadGanttViewElement will extract links data.

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

LinkEndMember

Gets or sets a property name which will be used to extract the links end item.

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

LinkStartMember

Gets or sets a property name which will be used to extract links start item.

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

LinkTypeConverter

Gets or sets a link type converter that will be used to convert values coming from the data source to TasksLinkType and vice versa.

Declaration
public LinkTypeConverter LinkTypeConverter { get; set; }
Property Value
LinkTypeConverter

The link type converter.

LinkTypeMember

Gets or sets a property name which will be used to extract the link type of the data items.

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

MinimumColumnWidth

Gets or sets the minimum width of a column.

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

The minimum width of a column.

MinimumLinkLength

Gets or sets the minimum length of the link.

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

The minimum length of the link.

MinimumTaskWidth

Gets or sets the minimum width of a task when resizing it with the mouse. The size is in pixels and is for the current zoom.

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

The minimum width of the task.

ParentMember

Gets or sets a property name which will be used to define a relation of the data items.

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

ProgressMember

Gets or sets a property name which will be used to extract the Progress of the data items.

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

Ratio

Gets or sets the ratio between the text view and the graphical view.

Declaration
public float Ratio { get; set; }
Property Value
System.Single

The ratio.

ReadOnly

Gets or sets a value indicating whether the gantt view is read only.

Declaration
public bool ReadOnly { get; set; }
Property Value
System.Boolean

true if the gantt view is read only; otherwise, false.

ScrollBehavior

Gets the ScrollServiceBehavior that is responsible for kinetic scrolling.

Declaration
public ScrollServiceBehavior ScrollBehavior { get; }
Property Value
ScrollServiceBehavior

SelectedItem

Gets or sets the selected item.

Declaration
public GanttViewDataItem SelectedItem { get; set; }
Property Value
GanttViewDataItem

The selected item.

ShowTimelineTodayIndicator

Gets or sets a value indicating whether to show the timeline today indicator.

Declaration
public bool ShowTimelineTodayIndicator { get; set; }
Property Value
System.Boolean

true if the timeline today indicator is visible; otherwise, false.

ShowTodayIndicator

Gets or sets a value indicating whether to show the today indicator.

Declaration
public bool ShowTodayIndicator { get; set; }
Property Value
System.Boolean

true if the today indicator is visible; otherwise, false.

SplitterElement

Gets the GanttViewViewsSplitterElement.

Declaration
public GanttViewViewsSplitterElement SplitterElement { get; }
Property Value
GanttViewViewsSplitterElement

The splitter element.

SplitterWidth

Gets or sets the width of the splitter.

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

The width of the splitter.

StartMember

Gets or sets a property name which will be used to extract the start of the data items.

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

TaskDataMember

Gets or sets the name of the list or table in the data source from which the RadGanttViewElement will extract tasks data.

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

TextViewElement

Gets the GanttViewTextViewElement.

Declaration
public GanttViewTextViewElement TextViewElement { get; }
Property Value
GanttViewTextViewElement

The text view element.

TitleMember

Gets or sets a property name which will be used to extract the title of the data items.

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

Methods

ArrangeOverride(SizeF)

Declaration
protected override SizeF ArrangeOverride(SizeF finalSize)
Parameters
System.Drawing.SizeF finalSize

Returns
System.Drawing.SizeF

Overrides

BeginEdit()

Puts the current item in edit mode, allowing the user to modify its properties.

Declaration
public virtual bool BeginEdit()
Returns
System.Boolean

true if editing was successfully initiated; otherwise, false.

BeginUpdate()

Begins an update operation, suspending view refreshes until EndUpdate() is called.

Declaration
public void BeginUpdate()

BringIntoView(GanttViewDataItem)

Brings the specified item into view by expanding parent items if necessary and scrolling to make it visible.

Declaration
public void BringIntoView(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The GanttViewDataItem to bring into view.

CancelEdit()

Closes the currently active editor and discards any changes made during the edit operation.

Declaration
public void CancelEdit()

ClearSelection()

Clears the current selection by removing the current and selected state from the currently selected item.

Declaration
public void ClearSelection()

CreateChildElements()

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration
protected override void CreateChildElements()
Overrides

CreateGraphicalViewElement(RadGanttViewElement)

Creates and returns a new instance of GanttViewGraphicalViewElement. This method can be overridden to provide custom graphical view element implementations.

Declaration
protected virtual GanttViewGraphicalViewElement CreateGraphicalViewElement(RadGanttViewElement ganttView)
Parameters
RadGanttViewElement ganttView

The parent RadGanttViewElement that will contain the graphical view element.
Returns
GanttViewGraphicalViewElement

A new instance of GanttViewGraphicalViewElement.

CreateNewTask()

Creates a new task.

Declaration
protected virtual GanttViewDataItem CreateNewTask()
Returns
GanttViewDataItem

A new GanttViewDataItem

CreateTextViewElement(RadGanttViewElement)

Creates and returns a new instance of GanttViewTextViewElement. This method can be overridden to provide custom text view element implementations.

Declaration
protected virtual GanttViewTextViewElement CreateTextViewElement(RadGanttViewElement ganttView)
Parameters
RadGanttViewElement ganttView

The parent RadGanttViewElement that will contain the text view element.
Returns
GanttViewTextViewElement

A new instance of GanttViewTextViewElement.

CreateViewsSplitterElement()

Creates and returns a new instance of GanttViewViewsSplitterElement. This method can be overridden to provide custom splitter element implementations.

Declaration
protected virtual GanttViewViewsSplitterElement CreateViewsSplitterElement()
Returns
GanttViewViewsSplitterElement

A new instance of GanttViewViewsSplitterElement.

EndEdit()

Commits any changes and ends the edit operation on the current item.

Declaration
public bool EndEdit()
Returns
System.Boolean

true if the edit operation was successfully ended and changes were committed; otherwise, false.

EndEditCore(Boolean)

Ends the editing of an item and commits or discards the changes based on the specified parameter.

Declaration
protected virtual bool EndEditCore(bool commitChanges)
Parameters
System.Boolean commitChanges

true to commit the changes; false to discard them.
Returns
System.Boolean

true if the edit operation was successfully ended; otherwise, false.

EndUpdate()

Ends the update operation and refreshes the view with any pending changes.

Declaration
public void EndUpdate()

EndUpdate(Boolean, RadGanttViewElement.UpdateActions)

Ends the update operation with control over whether to perform an update and the specific action to take.

Declaration
public void EndUpdate(bool performUpdate, RadGanttViewElement.UpdateActions action)
Parameters
System.Boolean performUpdate

True to perform an update; false to skip the update.
RadGanttViewElement.UpdateActions action

The RadGanttViewElement.UpdateActions specifying the type of update to perform.

EnsureItemVisibleHorizontal(GanttViewDataItem, GanttViewBaseItemElement)

Ensures that the specified item is visible horizontally in the view by scrolling if necessary.

Declaration
protected virtual void EnsureItemVisibleHorizontal(GanttViewDataItem item, GanttViewBaseItemElement itemElement)
Parameters
GanttViewDataItem item

The GanttViewDataItem to make visible.
GanttViewBaseItemElement itemElement

The GanttViewBaseItemElement representing the item.

EnsureItemVisibleVertical(GanttViewDataItem, GanttViewBaseItemElement)

Ensures that the specified item is visible vertically in the view by scrolling if necessary.

Declaration
protected virtual GanttViewBaseItemElement EnsureItemVisibleVertical(GanttViewDataItem item, GanttViewBaseItemElement itemElement)
Parameters
GanttViewDataItem item

The GanttViewDataItem to make visible.
GanttViewBaseItemElement itemElement

The GanttViewBaseItemElement representing the item, or null if not yet created.
Returns
GanttViewBaseItemElement

The GanttViewBaseItemElement for the item after ensuring it's visible.

EnsureItemVisibleVerticalCore(GanttViewDataItem)

Core implementation that ensures an item is visible vertically by calculating scroll offsets and updating the view.

Declaration
protected virtual GanttViewBaseItemElement EnsureItemVisibleVerticalCore(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The GanttViewDataItem to make visible.
Returns
GanttViewBaseItemElement

The GanttViewBaseItemElement for the item after ensuring it's visible, or null if not found.

EnsureVisible(GanttViewDataItem)

Ensures that the specified item is visible within the gantt view element, scrolling the contents of the element if necessary.

Declaration
public void EnsureVisible(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The item to scroll into view

GetEditor(Type)

Gets an editor instance of the specified type, creating it if not already cached.

Declaration
protected virtual IInputEditor GetEditor(Type editorType)
Parameters
System.Type editorType

The System.Type of the editor to retrieve.
Returns
IInputEditor

An IInputEditor instance of the specified type, or null if creation fails.

InitializeFields()

Initializes the fields.

Declaration
protected override void InitializeFields()
Overrides

MeasureOverride(SizeF)

Declaration
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters
System.Drawing.SizeF availableSize

Returns
System.Drawing.SizeF

Overrides

OnBindingContextChanged(EventArgs)

Raises the BindingContextChanged event.

Declaration
protected virtual void OnBindingContextChanged(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnContextMenuOpening(GanttViewContextMenuOpeningEventArgs)

Raises the ContextMenuOpening event.

Declaration
protected virtual void OnContextMenuOpening(GanttViewContextMenuOpeningEventArgs e)
Parameters
GanttViewContextMenuOpeningEventArgs e

The GanttViewContextMenuOpeningEventArgs instance containing the event data.

OnCreateDataItem(CreateGanttDataItemEventArgs)

Raises the CreateDataItem event.

Declaration
protected virtual void OnCreateDataItem(CreateGanttDataItemEventArgs e)
Parameters
CreateGanttDataItemEventArgs e

The CreateGanttDataItemEventArgs instance containing the event data.

OnCreateLinkDataItem(CreateGanttLinkDataItemEventArgs)

Raises the CreateLinkDataItem event.

Declaration
protected virtual void OnCreateLinkDataItem(CreateGanttLinkDataItemEventArgs e)
Parameters
CreateGanttLinkDataItemEventArgs e

The CreateGanttLinkDataItemEventArgs instance containing the event data.

OnDataCellCreating(GanttViewDataCellElementCreatingEventArgs)

Raises the DataCellCreating event.

Declaration
protected virtual void OnDataCellCreating(GanttViewDataCellElementCreatingEventArgs e)
Parameters
GanttViewDataCellElementCreatingEventArgs e

The GanttViewDataCellElementCreatingEventArgs instance containing the event data.

OnEditorInitialized(GanttViewItemEditorInitializedEventArgs)

Raises the EditorInitialized event.

Declaration
protected virtual void OnEditorInitialized(GanttViewItemEditorInitializedEventArgs e)
Parameters
GanttViewItemEditorInitializedEventArgs e

The GanttViewItemEditorInitializedEventArgs instance containing the event data.

OnEditorRequired(GanttViewEditorRequiredEventArgs)

Raises the EditorRequired event.

Declaration
protected virtual void OnEditorRequired(GanttViewEditorRequiredEventArgs e)
Parameters
GanttViewEditorRequiredEventArgs e

The GanttViewEditorRequiredEventArgs instance containing the event data.

OnGraphicalViewItemFormatting(GanttViewGraphicalViewItemFormattingEventArgs)

Raises the GraphicalViewItemFormatting event.

Declaration
protected virtual void OnGraphicalViewItemFormatting(GanttViewGraphicalViewItemFormattingEventArgs e)
Parameters
GanttViewGraphicalViewItemFormattingEventArgs e

The GanttViewGraphicalViewItemFormattingEventArgs instance containing the event data.

OnGraphicalViewLinkItemFormatting(GanttViewLinkItemFormattingEventArgs)

Raises the GraphicalViewLinkItemFormatting event.

Declaration
protected virtual void OnGraphicalViewLinkItemFormatting(GanttViewLinkItemFormattingEventArgs e)
Parameters
GanttViewLinkItemFormattingEventArgs e

The GanttViewLinkItemFormattingEventArgs instance containing the event data.

OnHeaderCellCreating(GanttViewHeaderCellElementCreatingEventArgs)

Raises the HeaderCellCreating event.

Declaration
protected virtual void OnHeaderCellCreating(GanttViewHeaderCellElementCreatingEventArgs e)
Parameters
GanttViewHeaderCellElementCreatingEventArgs e

The GanttViewHeaderCellElementCreatingEventArgs instance containing the event data.

OnItemAdded(GanttViewItemAddedEventArgs)

Raises the ItemAdded event.

Declaration
protected virtual void OnItemAdded(GanttViewItemAddedEventArgs e)
Parameters
GanttViewItemAddedEventArgs e

The GanttViewItemAddedEventArgs instance containing the event data.

OnItemAdding(GanttViewItemAddingEventArgs)

Raises the ItemAdding event.

Declaration
protected virtual void OnItemAdding(GanttViewItemAddingEventArgs e)
Parameters
GanttViewItemAddingEventArgs e

The GanttViewItemAddingEventArgs instance containing the event data.

OnItemChanged(GanttViewItemChangedEventArgs)

Raises the ItemChanged event.

Declaration
protected virtual void OnItemChanged(GanttViewItemChangedEventArgs e)
Parameters
GanttViewItemChangedEventArgs e

The GanttViewItemChangedEventArgs instance containing the event data.

OnItemChildIdNeeded(GanttViewItemChildIdNeededEventArgs)

Raises the ItemChildIdNeeded event.

Declaration
protected virtual void OnItemChildIdNeeded(GanttViewItemChildIdNeededEventArgs e)
Parameters
GanttViewItemChildIdNeededEventArgs e

The GanttViewItemChildIdNeededEventArgs instance containing the event data.

OnItemDataBound(GanttViewItemDataBoundEventArgs)

Raises the ItemDataBound event.

Declaration
protected virtual void OnItemDataBound(GanttViewItemDataBoundEventArgs e)
Parameters
GanttViewItemDataBoundEventArgs e

The GanttViewItemDataBoundEventArgs instance containing the event data.

OnItemDataError(GanttViewItemDataErrorEventArgs)

Raises the ItemDataError event.

Declaration
protected virtual void OnItemDataError(GanttViewItemDataErrorEventArgs e)
Parameters
GanttViewItemDataErrorEventArgs e

The GanttViewItemDataErrorEventArgs instance containing the event data.

OnItemEdited(GanttViewItemEditedEventArgs)

Raises the ItemEdited event.

Declaration
protected virtual void OnItemEdited(GanttViewItemEditedEventArgs e)
Parameters
GanttViewItemEditedEventArgs e

The GanttViewItemEditedEventArgs instance containing the event data.

OnItemEditing(GanttViewItemEditingEventArgs)

Raises the Editing event.

Declaration
protected virtual void OnItemEditing(GanttViewItemEditingEventArgs e)
Parameters
GanttViewItemEditingEventArgs e

The GanttViewItemEditingEventArgs instance containing the event data.

OnItemElementCreating(GanttViewItemElementCreatingEventArgs)

Raises the ItemElementCreating event.

Declaration
protected virtual void OnItemElementCreating(GanttViewItemElementCreatingEventArgs e)
Parameters
GanttViewItemElementCreatingEventArgs e

The GanttViewItemElementCreatingEventArgs instance containing the event data.

OnItemExpandedChanged(GanttViewExpandedChangedEventArgs)

Raises the ItemExpandedChanged event.

Declaration
protected virtual void OnItemExpandedChanged(GanttViewExpandedChangedEventArgs e)
Parameters
GanttViewExpandedChangedEventArgs e

The GanttViewExpandedChangedEventArgs instance containing the event data.

OnItemExpandedChanging(GanttViewDataItem)

Called when an item expanded is changing.

Declaration
protected bool OnItemExpandedChanging(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The item.
Returns
System.Boolean

OnItemExpandedChanging(GanttViewExpandedChangingEventArgs)

Raises the ItemExpandedChanging event.

Declaration
protected virtual void OnItemExpandedChanging(GanttViewExpandedChangingEventArgs e)
Parameters
GanttViewExpandedChangingEventArgs e

The GanttViewExpandedChangingEventArgs instance containing the event data.

OnItemPaint(GanttViewItemPaintEventArgs)

Raises the ItemPaint event.

Declaration
protected virtual void OnItemPaint(GanttViewItemPaintEventArgs e)
Parameters
GanttViewItemPaintEventArgs e

The GanttViewItemPaintEventArgs instance containing the event data.
Exceptions
System.NotImplementedException

OnItemRemoved(GanttViewItemRemovedEventArgs)

Raises the ItemRemoved event.

Declaration
protected virtual void OnItemRemoved(GanttViewItemRemovedEventArgs e)
Parameters
GanttViewItemRemovedEventArgs e

The GanttViewItemRemovedEventArgs instance containing the event data.

OnItemValidated(GanttViewItemValidatedEventArgs)

Raises the ItemValidated event.

Declaration
protected virtual void OnItemValidated(GanttViewItemValidatedEventArgs e)
Parameters
GanttViewItemValidatedEventArgs e

The GanttViewItemValidatedEventArgs instance containing the event data.

OnItemValidating(GanttViewItemValidatingEventArgs)

Raises the ItemValidating event.

Declaration
protected virtual void OnItemValidating(GanttViewItemValidatingEventArgs e)
Parameters
GanttViewItemValidatingEventArgs e

The GanttViewItemValidatingEventArgs instance containing the event data.

OnLinkAdded(GanttViewLinkAddedEventArgs)

Raises the LinkAdded event.

Declaration
protected virtual void OnLinkAdded(GanttViewLinkAddedEventArgs e)
Parameters
GanttViewLinkAddedEventArgs e

The GanttViewLinkAddedEventArgs instance containing the event data.

OnLinkAdding(GanttViewLinkAddingEventArgs)

Raises the LinkAdding event.

Declaration
protected virtual void OnLinkAdding(GanttViewLinkAddingEventArgs e)
Parameters
GanttViewLinkAddingEventArgs e

The GanttViewLinkAddingEventArgs instance containing the event data.

OnLinkChanged(GanttViewLinkChangedEventArgs)

Raises the LinkChanged event.

Declaration
protected virtual void OnLinkChanged(GanttViewLinkChangedEventArgs e)
Parameters
GanttViewLinkChangedEventArgs e

The GanttViewLinkChangedEventArgs instance containing the event data.

OnLinkDataBound(GanttViewLinkDataBoundEventArgs)

Raises the LinkDataBound event.

Declaration
protected virtual void OnLinkDataBound(GanttViewLinkDataBoundEventArgs e)
Parameters
GanttViewLinkDataBoundEventArgs e

The GanttViewLinkDataBoundEventArgs instance containing the event data.

OnLinkDataError(GanttViewLinkDataErrorEventArgs)

Raises the LinkDataError event.

Declaration
protected virtual void OnLinkDataError(GanttViewLinkDataErrorEventArgs e)
Parameters
GanttViewLinkDataErrorEventArgs e

The GanttViewLinkDataErrorEventArgs instance containing the event data.

OnLinkRemoved(GanttViewLinkRemovedEventArgs)

Raises the LinkRemoved event.

Declaration
protected virtual void OnLinkRemoved(GanttViewLinkRemovedEventArgs e)
Parameters
GanttViewLinkRemovedEventArgs e

The GanttViewLinkRemovedEventArgs instance containing the event data.

OnLoaded()

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration
protected override void OnLoaded()
Overrides

OnMouseDown(MouseEventArgs)

Raises the MouseDown event.

Declaration
protected override void OnMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnMouseMove(MouseEventArgs)

Raises the MouseMove event.

Declaration
protected override void OnMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnMouseUp(MouseEventArgs)

Raises the MouseUp event.

Declaration
protected override void OnMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Overrides

OnPropertyChanged(RadPropertyChangedEventArgs)

Raises the PropertyChanged event.

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

The RadPropertyChangedEventArgs instance containing the event data.
Overrides

OnRootCreated(EventArgs)

Raises the RootCreated event.

Declaration
protected virtual void OnRootCreated(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.

OnSelectedItemChanged(GanttViewSelectedItemChangedEventArgs)

Raises the SelectedItemChanged event.

Declaration
protected virtual void OnSelectedItemChanged(GanttViewSelectedItemChangedEventArgs e)
Parameters
GanttViewSelectedItemChangedEventArgs e

The GanttViewSelectedItemChangedEventArgs instance containing the event data.

OnSelectedItemChanging(GanttViewSelectedItemChangingEventArgs)

Raises the SelectedItemChanging event.

Declaration
protected virtual void OnSelectedItemChanging(GanttViewSelectedItemChangingEventArgs e)
Parameters
GanttViewSelectedItemChangingEventArgs e

The GanttViewSelectedItemChangingEventArgs instance containing the event data.

OnSelectedLinkChanged(GanttViewSelectedLinkChangedEventArgs)

Raises the SelectedLinkChanged event.

Declaration
protected virtual void OnSelectedLinkChanged(GanttViewSelectedLinkChangedEventArgs e)
Parameters
GanttViewSelectedLinkChangedEventArgs e

The GanttViewSelectedLinkChangedEventArgs instance containing the event data.

OnSelectedLinkChanging(GanttViewSelectedLinkChangingEventArgs)

Raises the SelectedLinkChanging event.

Declaration
protected virtual void OnSelectedLinkChanging(GanttViewSelectedLinkChangingEventArgs e)
Parameters
GanttViewSelectedLinkChangingEventArgs e

The GanttViewSelectedLinkChangingEventArgs instance containing the event data.

OnTextViewCellFormatting(GanttViewTextViewCellFormattingEventArgs)

Raises the TextViewCellFormatting event.

Declaration
protected virtual void OnTextViewCellFormatting(GanttViewTextViewCellFormattingEventArgs e)
Parameters
GanttViewTextViewCellFormattingEventArgs e

The GanttViewTextViewCellFormattingEventArgs instance containing the event data.

OnTextViewItemFormatting(GanttViewTextViewItemFormattingEventArgs)

Raises the TextViewItemFormatting event.

Declaration
protected virtual void OnTextViewItemFormatting(GanttViewTextViewItemFormattingEventArgs e)
Parameters
GanttViewTextViewItemFormattingEventArgs e

The GanttViewTextViewItemFormattingEventArgs instance containing the event data.

OnTimelineItemElementCreating(GanttViewTimelineItemElementCreatingEventArgs)

Raises the TimelineItemElementCreating event.

Declaration
protected virtual void OnTimelineItemElementCreating(GanttViewTimelineItemElementCreatingEventArgs e)
Parameters
GanttViewTimelineItemElementCreatingEventArgs e

The GanttViewTimelineItemElementCreatingEventArgs instance containing the event data.

OnTimelineItemFormatting(GanttViewTimelineItemFormattingEventArgs)

Raises the TimelineItemFormatting event.

Declaration
protected virtual void OnTimelineItemFormatting(GanttViewTimelineItemFormattingEventArgs e)
Parameters
GanttViewTimelineItemFormattingEventArgs e

The GanttViewTimelineItemFormattingEventArgs instance containing the event data.

ProcessCurrentItem(GanttViewDataItem)

Processes the item as current.

Declaration
protected virtual bool ProcessCurrentItem(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The item.
Returns
System.Boolean

ProcessDoubleClick(MouseEventArgs)

Processes double click.

Declaration
public virtual bool ProcessDoubleClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessKeyDown(KeyEventArgs)

Processes key down.

Declaration
public virtual bool ProcessKeyDown(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Returns
System.Boolean

ProcessKeyPress(KeyPressEventArgs)

Processes key press.

Declaration
public virtual bool ProcessKeyPress(KeyPressEventArgs e)
Parameters
System.Windows.Forms.KeyPressEventArgs e

The System.Windows.Forms.KeyPressEventArgs instance containing the event data.
Returns
System.Boolean

ProcessKeyUp(KeyEventArgs)

Processes key up.

Declaration
public virtual bool ProcessKeyUp(KeyEventArgs e)
Parameters
System.Windows.Forms.KeyEventArgs e

The System.Windows.Forms.KeyEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseClick(MouseEventArgs)

Processes mouse click.

Declaration
public virtual bool ProcessMouseClick(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseDown(MouseEventArgs)

Processes mouse down.

Declaration
public virtual bool ProcessMouseDown(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseEnter(EventArgs)

Processes mouse enter.

Declaration
public virtual bool ProcessMouseEnter(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseHover(EventArgs)

Processes mouse hover.

Declaration
public virtual bool ProcessMouseHover(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseLeave(EventArgs)

Processes mouse leave.

Declaration
public virtual bool ProcessMouseLeave(EventArgs e)
Parameters
System.EventArgs e

The System.EventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseMove(MouseEventArgs)

Processes mouse move.

Declaration
public virtual bool ProcessMouseMove(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseUp(MouseEventArgs)

Processes mouse up.

Declaration
public virtual bool ProcessMouseUp(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessMouseWheel(MouseEventArgs)

Processes mouse wheel.

Declaration
public virtual bool ProcessMouseWheel(MouseEventArgs e)
Parameters
System.Windows.Forms.MouseEventArgs e

The System.Windows.Forms.MouseEventArgs instance containing the event data.
Returns
System.Boolean

ProcessSelection(GanttViewDataItem)

Processes the item for selection.

Declaration
protected virtual void ProcessSelection(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The item.

ProcessSelection(GanttViewLinkDataItem)

Processes the item for selection.

Declaration
protected virtual void ProcessSelection(GanttViewLinkDataItem link)
Parameters
GanttViewLinkDataItem link

The item.

SynchronizeItemElements()

Synchronizes all item elements.

Declaration
protected virtual void SynchronizeItemElements()

Update(RadGanttViewElement.UpdateActions)

Updates the Gantt view according to the specified update action, refreshing both text and graphical views.

Declaration
public void Update(RadGanttViewElement.UpdateActions updateAction)
Parameters
RadGanttViewElement.UpdateActions updateAction

The RadGanttViewElement.UpdateActions specifying the type of update to perform.

Update(RadGanttViewElement.UpdateActions, GanttViewDataItem[])

Updates the visual items in the Gantt view for the specified data items according to the specified update action.

Declaration
public void Update(RadGanttViewElement.UpdateActions updateAction, params GanttViewDataItem[] items)
Parameters
RadGanttViewElement.UpdateActions updateAction

The RadGanttViewElement.UpdateActions specifying the type of update to perform.
GanttViewDataItem[] items

The array of GanttViewDataItem objects to update.

Update(RadGanttViewElement.UpdateActions, GanttViewLinkDataItem[])

Updates the Gantt view for the specified link data items according to the specified update action.

Declaration
public void Update(RadGanttViewElement.UpdateActions updateAction, params GanttViewLinkDataItem[] items)
Parameters
RadGanttViewElement.UpdateActions updateAction

The RadGanttViewElement.UpdateActions specifying the type of update to perform.
GanttViewLinkDataItem[] items

The array of GanttViewLinkDataItem objects to update.

UpdateOnExpandedChanged(GanttViewDataItem)

Updates the view when an item's expanded state changes by refreshing scroll ranges and adjusting scroll position.

Declaration
protected virtual bool UpdateOnExpandedChanged(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The GanttViewDataItem whose expanded state has changed.
Returns
System.Boolean

True if the update was successful; otherwise, false.

UpdateScrollers(GanttViewDataItem, RadGanttViewElement.UpdateActions)

Updates the scrollers.

Declaration
protected virtual void UpdateScrollers(GanttViewDataItem skipItem, RadGanttViewElement.UpdateActions updateAction)
Parameters
GanttViewDataItem skipItem

The skip item.
RadGanttViewElement.UpdateActions updateAction

The update action.

UpdateScrollersOnAdd(GanttViewDataItem)

Updates the scrollers on add.

Declaration
protected virtual void UpdateScrollersOnAdd(GanttViewDataItem item)
Parameters
GanttViewDataItem item

The item.

Events

BindingContextChanged

Occurs when the binding context is changed.

Declaration
public event EventHandler BindingContextChanged
Event Type
System.EventHandler

ContextMenuOpening

Occurs when a context menu is about to be opened.

Declaration
public event GanttViewContextMenuOpeningEventHandler ContextMenuOpening
Event Type
GanttViewContextMenuOpeningEventHandler

CreateDataItem

Occurs when a new data item is created.

Declaration
public event CreateGanttDataItemEventHandler CreateDataItem
Event Type
CreateGanttDataItemEventHandler

CreateLinkDataItem

Occurs when a new link data item is created.

Declaration
public event CreateGanttLinkDataItemEventHandler CreateLinkDataItem
Event Type
CreateGanttLinkDataItemEventHandler

DataCellElementCreating

Occurs when a new data cell element needs to be created.

Declaration
public event GanttViewDataCellElementCreatingEventHandler DataCellElementCreating
Event Type
GanttViewDataCellElementCreatingEventHandler

EditorInitialized

Occurs when an editor has been initialized.

Declaration
public event GanttViewItemEditorInitializedEventHandler EditorInitialized
Event Type
GanttViewItemEditorInitializedEventHandler

EditorRequired

Occurs when an editor is required to edit a cell the text view.

Declaration
public event GanttViewEditorRequiredEventHandler EditorRequired
Event Type
GanttViewEditorRequiredEventHandler

GraphicalViewItemFormatting

Occurs when the state of an item in the GanttViewGraphicalViewElement changes and it needs to be formatted.

Declaration
public event GanttViewGraphicalViewItemFormattingEventHandler GraphicalViewItemFormatting
Event Type
GanttViewGraphicalViewItemFormattingEventHandler

GraphicalViewLinkItemFormatting

Occurs when the state of a link item in the GanttViewGraphicalViewElement changes and it needs to be formatted.

Declaration
public event GanttViewLinkItemFormattingEventHandler GraphicalViewLinkItemFormatting
Event Type
GanttViewLinkItemFormattingEventHandler

HeaderCellElementCreating

Occurs when a new header cell element needs to be created.

Declaration
public event GanttViewHeaderCellElementCreatingEventHandler HeaderCellElementCreating
Event Type
GanttViewHeaderCellElementCreatingEventHandler

ItemAdded

Occurs when a new item is added to the Items collection.

Declaration
public event GanttViewItemAddedEventHandler ItemAdded
Event Type
GanttViewItemAddedEventHandler

ItemAdding

Occurs before an GanttViewDataItem is added to the Items collection.

Declaration
public event GanttItemAddingEventHandler ItemAdding
Event Type
GanttItemAddingEventHandler

ItemChanged

Occurs when an item's property is changed.

Declaration
public event GanttViewItemChangedEventhandler ItemChanged
Event Type
GanttViewItemChangedEventhandler

ItemChildIdNeeded

Occurs when an item needs an id for storing in data sources.

Declaration
public event GanttViewItemChildIdNeededEventHandler ItemChildIdNeeded
Event Type
GanttViewItemChildIdNeededEventHandler

ItemDataBound

Occurs when an item is data bound.

Declaration
public event GanttViewItemDataBoundEventHandler ItemDataBound
Event Type
GanttViewItemDataBoundEventHandler

ItemDataError

Fired when there is an error in the data layer of RadGanttView related to data operations with Item objects.

Declaration
public event GanttItemDataErrorEventHandler ItemDataError
Event Type
GanttItemDataErrorEventHandler

ItemEdited

Occurs when an item has been edited.

Declaration
public event GanttViewItemEditedEventHandler ItemEdited
Event Type
GanttViewItemEditedEventHandler

ItemEditing

Occurs when an cell is about to be edited.

Declaration
public event GanttViewItemEditingEventHandler ItemEditing
Event Type
GanttViewItemEditingEventHandler

ItemElementCreating

Occurs when an item element needs to be created.

Declaration
public event GanttViewItemElementCreatingEventHandler ItemElementCreating
Event Type
GanttViewItemElementCreatingEventHandler

ItemExpandedChanged

Occurs after an item is expanded or collapsed.

Declaration
public event GanttViewExpandedChangedEventHandler ItemExpandedChanged
Event Type
GanttViewExpandedChangedEventHandler

ItemExpandedChanging

Occurs when an item is about to be expanded or collapsed.

Declaration
public event GanttViewExpandedChangingEventHandler ItemExpandedChanging
Event Type
GanttViewExpandedChangingEventHandler

ItemPaint

Occurs when an item is painted. Allows custom painting over the item. EnableCustomPainting must be set to true for this event to be fired.

Declaration
public event GanttViewItemPaintEventHandler ItemPaint
Event Type
GanttViewItemPaintEventHandler

ItemRemoved

Occurs when an item removed from the Items collection.

Declaration
public event GanttViewItemRemovedEventHandler ItemRemoved
Event Type
GanttViewItemRemovedEventHandler

ItemValidated

Occurs when an item is validated.

Declaration
public event GanttViewItemValidatedEventHandler ItemValidated
Event Type
GanttViewItemValidatedEventHandler

ItemValidating

Occurs when an item validating is edited and needs to be validated.

Declaration
public event GanttViewItemValidatingEventHandler ItemValidating
Event Type
GanttViewItemValidatingEventHandler

LinkAdded

Occurs when a new link added to the Links collection.

Declaration
public event GanttViewLinkAddedEventHandler LinkAdded
Event Type
GanttViewLinkAddedEventHandler

LinkAdding

Occurs before an GanttViewLinkDataItem is added to the Links collection.

Declaration
public event GanttLinkAddingEventHandler LinkAdding
Event Type
GanttLinkAddingEventHandler

LinkChanged

Occurs when a link's property is changed.

Declaration
public event GanttViewLinkChangedEventHandler LinkChanged
Event Type
GanttViewLinkChangedEventHandler

LinkDataBound

Occurs when a link is data bound.

Declaration
public event GanttViewLinkDataBoundEventHandler LinkDataBound
Event Type
GanttViewLinkDataBoundEventHandler

LinkDataError

Fired when there is an error in the data layer of RadGanttView related to data operations with Link objects.

Declaration
public event GanttLinkDataErrorEventHandler LinkDataError
Event Type
GanttLinkDataErrorEventHandler

LinkRemoved

Occurs when a link is removed from the Links collection.

Declaration
public event GanttViewLinkRemovedEventHandler LinkRemoved
Event Type
GanttViewLinkRemovedEventHandler

RootCreated

Occurs when the root item is created.

Declaration
public event EventHandler RootCreated
Event Type
System.EventHandler

SelectedItemChanged

Occurs when selected item has been changed.

Declaration
public event GanttViewSelectedItemChangedEventHandler SelectedItemChanged
Event Type
GanttViewSelectedItemChangedEventHandler

SelectedItemChanging

Occurs when the selected item is about to be changed.

Declaration
public event GanttViewSelectedItemChangingEventHandler SelectedItemChanging
Event Type
GanttViewSelectedItemChangingEventHandler

SelectedLinkChanged

Occurs when selected link has been changed.

Declaration
public event GanttViewSelectedLinkChangedEventHandler SelectedLinkChanged
Event Type
GanttViewSelectedLinkChangedEventHandler

SelectedLinkChanging

Occurs when the selected link is about to be changed.

Declaration
public event GanttViewSelectedLinkChangingEventHandler SelectedLinkChanging
Event Type
GanttViewSelectedLinkChangingEventHandler

TextViewCellFormatting

Occurs when the content of a cell needs to be formatted for display.

Declaration
public event GanttViewTextViewCellFormattingEventHandler TextViewCellFormatting
Event Type
GanttViewTextViewCellFormattingEventHandler

TextViewItemFormatting

Occurs when the state of an item in the GanttViewTextViewElement changes and it needs to be formatted.

Declaration
public event GanttViewTextViewItemFormattingEventHandler TextViewItemFormatting
Event Type
GanttViewTextViewItemFormattingEventHandler

TimelineItemElementCreating

Occurs when a timeline item element needs to be created.

Declaration
public event GanttViewTimelineItemElementCreatingEventHandler TimelineItemElementCreating
Event Type
GanttViewTimelineItemElementCreatingEventHandler

TimelineItemFormatting

Occurs when the state of a timeline item changes and it needs to be formatted.

Declaration
public event GanttViewTimelineItemFormattingEventHandler TimelineItemFormatting
Event Type
GanttViewTimelineItemFormattingEventHandler

Extension Methods