RadGantt
Contains event definitions for the RadGantt control.
Definition
Namespace:Telerik.Web.UI
Assembly:Telerik.Web.UI.dll
Syntax:
[RequiredScript(typeof(jQueryPlugins), 1)]
[RequiredScript(typeof(Html5Gantt), 2)]
[RequiredScript(typeof(MaterialRipple))]
[ClientScriptResource("Telerik.Web.UI.RadGantt", "Telerik.Web.UI.Gantt.RadGanttScripts.js", LoadOrder = 3)]
[EmbeddedSkin("Gantt", typeof(RadGantt))]
[EmbeddedSkin("Gantt", "Default", typeof(RadGantt))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadGantt))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[TelerikToolboxCategory("Calendar, Scheduler and Gantt")]
[ToolboxBitmap(typeof(RadGantt), "Toolbox.Icons.Gantt.png")]
public class RadGantt : RadDataBoundControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, INamingContainer, IGantt, ICallbackEventHandler, IPostBackEventHandlerInheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlRadGantt...
Implements:
Inherited Members
Constructors
public RadGantt()Properties
Gets or sets a value indicating whether the columns can be resized.
[ClientControlProperty]
[ClientPropertyName("allowColumnResize")]
public bool AllowColumnResize { get; set; }Gets or sets a value indicating whether the user is able to delete a dependency.
[ClientControlProperty]
[ClientPropertyName("allowDependencyDelete")]
public bool AllowDependencyDelete { get; set; }Gets or sets a value indicating whether the user is able to insert a dependency.
[ClientControlProperty]
[ClientPropertyName("allowDependencyInsert")]
public bool AllowDependencyInsert { get; set; }Gets or sets a value indicating whether the user is able to drag PercetComplete of a task.
[ClientControlProperty]
[ClientPropertyName("allowPercentCompleteDrag")]
public bool AllowPercentCompleteDrag { get; set; }If set to true the default pop-up editor of the Gantt will render the plannedStart and plannedEnd editors for the edited task..
[ClientControlProperty]
[ClientPropertyName("allowPlannedTasks")]
public bool AllowPlannedTasks { get; set; }Gets or sets a value indicating whether sorting is enabled for the tree list part.
public bool AllowSorting { get; set; }Gets or sets a value indicating whether the user is able to delete a task.
[ClientControlProperty]
[ClientPropertyName("allowTaskDelete")]
public bool AllowTaskDelete { get; set; }Gets or sets a value indicating whether the user is able to insert a task.
[ClientControlProperty]
[ClientPropertyName("allowTaskInsert")]
public bool AllowTaskInsert { get; set; }Gets or sets a value indicating whether the user is able to move a task.
[ClientControlProperty]
[ClientPropertyName("allowTaskMove")]
public bool AllowTaskMove { get; set; }Gets or sets a value indicating whether the user is able to reorder a task.
[ClientControlProperty]
[ClientPropertyName("allowTaskReorder")]
public bool AllowTaskReorder { get; set; }Gets or sets a value indicating whether the user is able to resize a task.
[ClientControlProperty]
[ClientPropertyName("allowTaskResize")]
public bool AllowTaskResize { get; set; }Gets or sets a value indicating whether the user is able to update a task.
[ClientControlProperty]
[ClientPropertyName("allowTaskUpdate")]
public bool AllowTaskUpdate { get; set; }[Browsable(false)]
public virtual AssignmentCollection Assignments { get; }protected virtual AssignmentsBinder AssignmentsBinder { get; }Gets or sets data source for resource assignments.
[Browsable(false)]
public object AssignmentsDataSource { get; set; }Gets or sets the DataSource used to bind resource assignments
public virtual string AssignmentsDataSourceID { get; set; }public DataSourceView AssignmentsView { get; }Implements:
Gets or sets a value indicating whether bound columns are automatically created
for each field in the data source.
public virtual bool AutoGenerateColumns { get; set; }Implements:
Gets or sets the HTML template of the RadGantt tasks.
[PersistenceMode(PersistenceMode.InnerProperty)]
[ClientControlProperty]
[ClientPropertyName("clientTemplate")]
[Browsable(false)]
public string ClientTemplate { get; set; }Gets the available columns.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ColumnCollection Columns { get; }The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()
protected override string CssClassFormatString { get; }Overrides:
Gets or sets the selected culture. Localization strings will be loaded based on this value.
public CultureInfo Culture { get; set; }The culture.
Gets or sets a value indicating the number of milliseconds after which the current time marker is updated.
[ClientControlProperty]
[ClientPropertyName("currentTimeMarkerInterval")]
public int CurrentTimeMarkerInterval { get; set; }Gets the additional task fields.
[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual CustomFieldCollection CustomTaskFields { get; }[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual GanttDataBindings DataBindings { get; }Implements:
Gets the Day view settings.
[PersistenceMode(PersistenceMode.InnerProperty)]
public DayViewSettings DayView { get; }The day view.
protected IColumnFactory DefaultColumnsFactory { get; }[Browsable(false)]
public virtual DependencyCollection Dependencies { get; }Implements:
protected virtual DependenciesBinder DependenciesBinder { get; }Gets or sets data source for dependencies.
[Browsable(false)]
public object DependenciesDataSource { get; set; }Gets or sets the DataSource used to bind dependencies
public virtual string DependenciesDataSourceID { get; set; }public DataSourceView DependenciesView { get; }Implements:
Gets or sets a value indicating whether a delete confirmation dialog should be displayed when the user deletes a task or a dependency.
[ClientControlProperty]
[ClientPropertyName("displayDeleteConfirmation")]
public bool DisplayDeleteConfirmation { get; set; }true if the confirmation dialog should be displayed;
protected virtual bool DoExplicitDataBind { get; }Gets or sets a value indicating whether the export to PDF functionality is enabled.
[ClientControlProperty]
[ClientPropertyName("enablePdfExport")]
public bool EnablePdfExport { get; set; }Gets or sets a value indicating whether the resources functionality is enabled.
[ClientControlProperty]
[ClientPropertyName("enableResources")]
public bool EnableResources { get; set; }[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual FilterEntryCollection Entries { get; }Gets the Export settings.
[PersistenceMode(PersistenceMode.InnerProperty)]
public GanttExportSettings ExportSettings { get; }protected bool HasCustomProvider { get; }[ClientControlProperty]
[ClientPropertyName("height")]
public override Unit Height { get; set; }Overrides:
Used to customize the Gantt keyboard navigation functionality
[PersistenceMode(PersistenceMode.InnerProperty)]
public GanttKeyboardNavigationSettings KeyboardNavigationSettings { get; }Gets or sets the RadGantt list width in pixels or percents.
[ClientControlProperty]
[ClientPropertyName("listWidth")]
public virtual Unit ListWidth { get; set; }Gets the localization.
[PersistenceMode(PersistenceMode.InnerProperty)]
public GanttStrings Localization { get; }The localization.
Gets or sets a value indicating where RadGantt will look for its .resx localization files.
public string LocalizationPath { get; set; }The localization path.
Gets the Month view settings.
[PersistenceMode(PersistenceMode.InnerProperty)]
public MonthViewSettings MonthView { get; }The month view.
Gets or sets the OnClientColumnResized.
[ClientControlEvent]
[ClientPropertyName("columnResized")]
public string OnClientColumnResized { get; set; }The OnClientColumnResized.
Gets or sets the OnClientDataBound.
[ClientControlEvent]
[ClientPropertyName("dataBound")]
public string OnClientDataBound { get; set; }The OnClientDataBound.
The event will be raised when a new task or a new dependency is about to be added.
[ClientControlEvent]
[ClientPropertyName("inserting")]
public string OnClientInserting { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
Gets or sets the OnClientKendoWidgetInitializing event handler.
[ClientControlEvent]
[ClientPropertyName("kendoWidgetInitializing")]
public string OnClientKendoWidgetInitializing { get; set; }The OnClientKendoWidgetInitializing.
Fired when the Gantt control is loaded on the page.
[ClientControlEvent]
[ClientPropertyName("load")]
public string OnClientLoad { get; set; }Gets or sets a value indicating the client-side event handler that is called when the gantt is about to execute a navigation command such as view change.
[ClientControlEvent]
[ClientPropertyName("navigationCommand")]
public string OnClientNavigationCommand { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClientNavigationCommand client-side event handler is called when the gantt is about to execute a navigation command.
Two parameters are passed to the handler:
- sender, the scheduler client object;
- eventArgs with two properties:
- get_view(), the view name that is about to be selected.
- set_cancel(), used to cancel the event.
This event can be cancelled.
Gets or sets the OnClientPdfExporting.
[ClientControlEvent]
[ClientPropertyName("pdfExporting")]
public string OnClientPdfExporting { get; set; }The OnClientPdfExporting.
The event will be raised when a task or a dependency is about to be removed.
[ClientControlEvent]
[ClientPropertyName("removing")]
public string OnClientRemoving { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
Gets or sets a value indicating the client-side event handler that is called when a response from the WebService is received. If there is an error, the argument methods will return undefined. The Error handler is fired after this event in case of a failed request.
[ClientControlEvent]
[ClientPropertyName("requestEnd")]
public string OnClientRequestEnd { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
Gets or sets a value indicating the client-side event handler that is called when an error response from the WebService is received. This event is fired after RequestEnd event.
[ClientControlEvent]
[ClientPropertyName("requestFailed")]
public string OnClientRequestFailed { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
Gets or sets a value indicating the client-side event handler that is called when the gantt is about to make a request to the WebService.
[ClientControlEvent]
[ClientPropertyName("requestStart")]
public string OnClientRequestStart { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
The event will be raised when the user starts task edit upon double click on a cell.
[ClientControlEvent]
[ClientPropertyName("taskEditing")]
public string OnClientTaskEditing { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
Gets or sets a value indicating the client-side event handler that is called when an task has been moved.
[ClientControlEvent]
[ClientPropertyName("taskMoveEnd")]
public string OnClientTaskMoveEnd { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClientTaskMoveEnd client-side event handler is called when an task has been moved.
Two parameters are passed to the handler:
- sender, the gantt client object;
- eventArgs with three properties:
- get_task(), the instance of the task.
- get_start(), the new start time of the task.
- set_cancel(), set to true to cancel the move operation.
This event can be cancelled.
Gets or sets a value indicating the client-side event handler that is called when an task is about to be moved.
[ClientControlEvent]
[ClientPropertyName("taskMoveStart")]
public string OnClientTaskMoveStart { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClientTaskMoveStart client-side event handler is called when an task is about to be moved. Two parameters are passed to the handler:
- sender, the gantt client object;
- eventArgs with two properties:
- get_task(), the instance of the task.
- set_cancel(), set to true to cancel the move operation.
This event can be cancelled.
Gets or sets a value indicating the client-side event handler that is called when an task is being moved.
[ClientControlEvent]
[ClientPropertyName("taskMoving")]
public string OnClientTaskMoving { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
If specified, the OnClientTaskMoving client-side event handler is called when an task is being moved. Two parameters are passed to the handler:
- sender, the gantt client object;
- eventArgs with three properties:
- get_task(), the instance of the task.
- get_start(), the start date and time of the task.
- set_cancel(), set to true to cancel the move operation.
This event can be cancelled.
Gets or sets the OnClientTaskResizeEnd.
[ClientControlEvent]
[ClientPropertyName("taskResizeEnd")]
public string OnClientTaskResizeEnd { get; set; }The OnClientTaskResizeEnd.
Gets or sets the OnClientTaskResizeStart.
[ClientControlEvent]
[ClientPropertyName("taskResizeStart")]
public string OnClientTaskResizeStart { get; set; }The OnClientTaskResizeStart.
Gets or sets the OnClientTaskResizing.
[ClientControlEvent]
[ClientPropertyName("taskResizing")]
public string OnClientTaskResizing { get; set; }The OnClientTaskResizing.
The event will be raised when a task field is updated upon user interaction.
[ClientControlEvent]
[ClientPropertyName("taskSaving")]
public string OnClientTaskSaving { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
The event will be raised when the user selects a task in the Gantt.
[ClientControlEvent]
[ClientPropertyName("taskSelectionChanged")]
public string OnClientTaskSelectionChanged { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
The event will be raised when a task field is updated upon user interaction.
[ClientControlEvent]
[ClientPropertyName("taskUpdateCancel")]
public string OnClientTaskUpdateCancel { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
The event will be raised upon Toolbar PlannedTasks Switch click. As a result, the planned tasks will be either hidden or shown in the Gantt Timeline view. The event is preventable.
[ClientControlEvent]
[ClientPropertyName("togglePlannedTasks")]
public string OnClientTogglePlannedTasks { get; set; }A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.
Gets or sets the provider instance to be used by Gantt. Use this property with providers that are created at runtime. For ASP.NET providers defined in web.config use the ProviderName property.
[Browsable(false)]
public GanttProviderBase Provider { get; set; }The provider instance to be used by Gantt.
Gets or sets the name of the current tasks provider used by Gantt. The provider must be defined in the Gantt section of web.config.
[PersistenceMode(PersistenceMode.Attribute)]
public string ProviderName { get; set; }The name of the current tasks provider used by Gantt as defined in web.config.
Gets or sets the end range of the currently selected view.
[ClientControlProperty]
[ClientPropertyName("rangeEnd")]
public DateTime? RangeEnd { get; set; }Gets or sets the start range of the currently selected view.
[ClientControlProperty]
[ClientPropertyName("rangeStart")]
public DateTime? RangeStart { get; set; }Gets or sets a value indicating whether RadGantt is in read-only mode.
[ClientControlProperty]
[ClientPropertyName("readOnly")]
public virtual bool ReadOnly { get; set; }true if RadGantt should be read-only; false otherwise. The default value is false.
By default the user is able to select, insert, edit and delete tasks. Use the ReadOnly to disable the editing and selection capabilities of RadGantt.
protected virtual bool RequiresDataBinding { get; set; }Gets the resolved render mode.
public override RenderMode ResolvedRenderMode { get; }The resolved render mode.
Overrides:
[Browsable(false)]
public virtual ResourceCollection Resources { get; }protected virtual ResourcesBinder ResourcesBinder { get; }Gets or sets data source for resources.
[Browsable(false)]
public object ResourcesDataSource { get; set; }Gets or sets the DataSource used to bind resources
public virtual string ResourcesDataSourceID { get; set; }public DataSourceView ResourcesView { get; }Implements:
Gets or sets the height of RadGantt rows.
[ClientControlProperty]
[ClientPropertyName("rowHeight")]
public Unit RowHeight { get; set; }The height of a RadGantt row
Gets or sets the date to which the timeline of the currently selected view is scrolled.
[ClientControlProperty]
[ClientPropertyName("selectedDate")]
public DateTime? SelectedDate { get; set; }Gets or sets the current view type.
public GanttViewType SelectedView { get; set; }One of the GanttViewType values. The default is DayView.
Implements:
protected JavaScriptSerializer Serializer { get; }Gets or sets a value indicating whether the current time marker is visible.
[ClientControlProperty]
[ClientPropertyName("showCurrentTimeMarker")]
public bool ShowCurrentTimeMarker { get; set; }Gets or sets a value indicating whether to display the complete day or the range between 8:00 AM and 5:00 PM.
[ClientControlProperty]
public bool ShowFullTime { get; set; }true if showing the complete day; otherwise, false.
Gets or sets a value indicating whether to display all days of the week or the range between WorkWeekStart and WorkWeekEnd.
[ClientControlProperty]
public bool ShowFullWeek { get; set; }true if showing all week days; otherwise, false.
If set to true, the Gantt Timeline will render both the planned and the actual execution of tasks. In order to display properly, the Planned vs. Actual view would need the plannedStart and plannedEnd date fields for tasks to be set.
[ClientPropertyName("showPlannedTasks")]
public bool ShowPlannedTasks { get; set; }Gets or sets a value indicating whether to display a tooltip with summary of the task upon hovering.
[Obsolete("This property is obsolete in favor of the TasksTooltipSettings.Visible property.")]
public bool ShowTooltip { get; set; }Gets or sets a value that determines whether the tasks will snap to the nearest grid cell in the timeline.
[ClientControlProperty]
[ClientPropertyName("snapToGrid")]
public bool SnapToGrid { get; set; }protected override bool SupportsRenderingMode { get; }Overrides:
protected override HtmlTextWriterTag TagKey { get; }Overrides:
[Browsable(false)]
public virtual TaskCollection Tasks { get; }Implements:
Default Tooltip options for this the Gantt Tasks.
[PersistenceMode(PersistenceMode.InnerProperty)]
[ClientPropertyName("tooltip")]
[Browsable(false)]
public TasksTooltip TasksTooltipSettings { get; }public DataSourceView TasksView { get; }Implements:
Default Tooltip options for this the Gantt Tasks.
[PersistenceMode(PersistenceMode.InnerProperty)]
[ClientPropertyName("toolbar")]
[Browsable(false)]
public GanttToolbar Toolbar { get; }protected bool UsingWebServiceBinding { get; }protected IEnumerable<GanttBoundColumn> VisibleColumns { get; }Gets the web service settings to be used for binding this instance of RadGantt.
[PersistenceMode(PersistenceMode.InnerProperty)]
public WebServiceSettings WebServiceSettings { get; }The web service settings.
Gets the WeekView settings.
[PersistenceMode(PersistenceMode.InnerProperty)]
public WeekViewSettings WeekView { get; }The WeekView.
Gets or sets the RadGantt width in pixels or percents.
[ClientControlProperty]
[ClientPropertyName("width")]
public override Unit Width { get; set; }Overrides:
Gets or sets the last day of the work week.
[ClientControlProperty]
public DayOfWeek WorkWeekEnd { get; set; }Gets or sets the first day of the work week.
[ClientControlProperty]
public DayOfWeek WorkWeekStart { get; set; }Gets the Year view settings.
[PersistenceMode(PersistenceMode.InnerProperty)]
public YearViewSettings YearView { get; }The year view.
Methods
protected virtual void BindAssignments(IEnumerable<IAssignment> assignments)protected virtual void BindDependencies(IEnumerable<IDependency> dependencies)protected virtual void BindResources(IEnumerable<IResource> resources)protected override void CreateChildControls()Overrides:
protected virtual void CreateColumns()protected virtual void CreateViews()protected virtual void DescribeAssignments(IScriptDescriptor descriptor)protected virtual void DescribeColumns(IScriptDescriptor descriptor)protected override void DescribeComponent(IScriptDescriptor descriptor)Overrides:
protected virtual void DescribeCustomFields(IScriptDescriptor descriptor)protected virtual void DescribeDependencies(IScriptDescriptor descriptor)protected virtual void DescribeLocalization(IScriptDescriptor descriptor)protected virtual void DescribePostBack(IScriptDescriptor descriptor)protected virtual void DescribeResources(IScriptDescriptor descriptor)protected virtual void DescribeTasks(IScriptDescriptor descriptor)protected virtual void DescribeViews(IScriptDescriptor descriptor)protected override void EnsureDataBound()Overrides:
protected virtual void FireCommand(ICallbackCommandContext cmd)protected virtual void FirePostbackCommand(IPostbackCommandContext cmd)protected override IEnumerable<ScriptReference> GetScriptReferences()Overrides:
Populates the control from the specified MSProject XML file.
public void ImportXml(string xmlFileName)The name of the MSProject XML file.
Executed when post data is loaded from the request
protected override bool LoadPostData(string postDataKey, NameValueCollection postCollection)Overrides:
protected virtual void LoadProvider()protected virtual void OnColumnCreated(ColumnCreatedEventArgs e)protected virtual void OnColumnCreating(ColumnCreatingEventArgs e)protected override void OnDataPropertyChanged()Overrides:
protected virtual void OnNavigationCommand(NavigationCommandEventArgs e)protected override void PerformSelect()Overrides:
protected virtual void UpdateBinder(DataBoundControl binder, string dataSourceID)Events
Occurs when an assignment's collection is about to be deleted from the database through the provider.
public event AssignmentDeleteEventHandler AssignmentDeleteOccurs when an assignment's collection is about to be inserted in the database through the provider.
public event AssignmentInsertEventHandler AssignmentInsertOccurs when an assignment's collection is about to be updated through the provider.
public event AssignmentUpdateEventHandler AssignmentUpdateOccurs after a column was created. You can handle the event to grab an instance of the newly created column.
public event ColumnCreatedEventHandler ColumnCreatedOccurs before a column is created. You can handle the event to replace or modify the instance of the column that should be created and added into the collection of column in the corresponding
public event ColumnCreatingEventHandler ColumnCreatingOccurs when a dependency's collection is about to be deleted from the database through the provider.
public event DependencyDeleteEventHandler DependencyDeleteOccurs when a dependency's collection is about to be inserted in the database through the provider.
public event DependencyInsertEventHandler DependencyInsertOccurs when the RadGantt executes a navigation command.
public event NavigationCommandEventHandler NavigationCommandOccurs when a task's collection is about to be deleted from the database through the provider.
public event TaskDeleteEventHandler TaskDeleteOccurs when a task's collection is about to be inserted in the database through the provider.
public event TaskInsertEventHandler TaskInsertOccurs when a task's collection is about to be updated through the provider.
public event TaskUpdateEventHandler TaskUpdate