Class GanttActionEventArgs<TValue>

Class that Gantt Action Event details.

Inheritance

System.Object

GanttActionEventArgs<TValue>

Namespace: Syncfusion.Blazor.Gantt

Assembly: Syncfusion.Blazor.dll

Syntax

public class GanttActionEventArgs<TValue> : Object

Type Parameters

Name	Description
TValue	Specifies the type of DateValidation.

Constructors

GanttActionEventArgs()

Declaration

public GanttActionEventArgs()

Properties

Action

Gets the current action.

Declaration

public string Action { get; }

Property Value

Type	Description
System.String	The string value representing the current action.

Remarks

Use this property to define the current action associated with the instance. The action is specified as a string value.

Cancel

Cancel the print action.

Declaration

public bool Cancel { get; set; }

Property Value

Type	Description
System.Boolean	true, if the print action can be canceled. Otherwise, false.

ColumnName

Gets the field name of the currently grouped columns.

Declaration

public string ColumnName { get; }

Property Value

Type	Description
System.String	The string value representing the field name of the currently grouped columns.

Remarks

Use this property to define the field name of the columns that are currently grouped. The field name is specified as a string value.

Columns

Gets or sets the collection of filtered columns.

Declaration

public List<PredicateModel<object>> Columns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<PredicateModel<System.Object>>	A System.Collections.Generic.List<> of PredicateModel<T> objects that specifies the collection of filtered columns in the Gantt chart.

Remarks

Use this property to define the collection of filtered columns in the Gantt chart. The filtered columns are represented as PredicateModel<T> objects, where the generic type parameter is System.Object.

CurrentFilteringColumn

Gets the column name that is currently filtered.

Declaration

public string CurrentFilteringColumn { get; }

Property Value

Type	Description
System.String	The string value representing the column name that is currently filtered in the Gantt chart.

Remarks

Use this property to define the column name that is currently being used for filtering in the Gantt chart. The column name is specified as a string value.

CurrentFilterObject

Gets or sets the object that is currently filtered.

Declaration

public PredicateModel<object> CurrentFilterObject { get; set; }

Property Value

Type	Description
PredicateModel<System.Object>	A PredicateModel<T> object that specifies the object that is currently filtered in the Gantt chart.

Remarks

Use this property to define the object that is currently filtered in the Gantt chart. The filtered object is represented as a PredicateModel<T> object, where the generic type parameter is System.Object.

CurrentPage

Gets or sets the current page number.

Declaration

public int CurrentPage { get; set; }

Property Value

Type	Description
System.Int32	An integer representing the current page number in the Gantt Chart.

CurrentZoomingLevel

Gets or sets the current zooming level for the GanttChart timeline.

Declaration

public GanttZoomTimelineSettings CurrentZoomingLevel { get; set; }

Property Value

Type	Description
GanttZoomTimelineSettings	An instance of the GanttZoomTimelineSettings class that represents the current zooming level for the GanttChart timeline.

Remarks

The CurrentZoomingLevel property represents the current zooming level for the GanttChart timeline. It should be set to an instance of the GanttZoomTimelineSettings class, which defines the zooming options and settings for the timeline.

Data

Gets or sets the record objects for the Gantt chart.

Declaration

public TValue Data { get; set; }

Property Value

Type	Description
TValue	A value representing the record objects for the Gantt chart.

Remarks

Use this property to define the record objects that are associated with the Gantt chart. The record objects are represented by the type specified by TValue.

Direction

Gets or sets the direction of the sort column.

Declaration

public SortDirection Direction { get; set; }

Property Value

Type	Description
SortDirection	One of the SortDirection enumeration values.

Remarks

Use this property to define the direction of the sort column in the Gantt chart. The direction is specified as one of the values from the SortDirection enumeration.

EditContext

Gets or sets the current EditContext instance for the form.

Declaration

public EditContext EditContext { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.Forms.EditContext	An instance of the EditContext class that represents the current edit context for the form.

Remarks

The EditContext property represents the current EditContext instance for the form. It should be set to an instance of the EditContext class that is responsible for tracking the state of the form and managing validation.

EditEventArgs

Gets or sets the edited event arguments.

Declaration

public EditedArgs EditEventArgs { get; set; }

Property Value

Type	Description
Syncfusion.Blazor.Gantt.Internal.EditedArgs	The event arguments for an edited event.

Remarks

Use this property to access the event arguments for an edited event. The event arguments are represented by the type specified by Syncfusion.Blazor.Gantt.Internal.EditedArgs.

EnableAutoLinkValidation

Gets or sets whether to enable or disable validation on drawing predecessor (connector) via user interaction.

Declaration

public bool EnableAutoLinkValidation { get; set; }

Property Value

Type	Description
System.Boolean	true if validation should be enabled for drawing predecessors via user interaction; otherwise, false. The default value is true.

Remarks

The EnableAutoLinkValidation property determines whether validation should be performed when drawing predecessors (connectors) via user interaction in the GanttChart component. By default, the EnableAutoLinkValidation property is set to true, indicating that validation is enabled. When validation is enabled, the GanttChart component will validate the drawing of predecessors based on predefined rules or constraints.

ExcelSearchOperator

Gets or sets the Excel search operator.

Declaration

public Operator ExcelSearchOperator { get; set; }

Property Value

Type	Description
Operator	One of the Operator enumeration values that specifies the Excel search operator. The default value is None.

Remarks

Use this property to define the Excel search operator to be used in operations. The operator is represented as one of the values from the Operator enumeration. The default value is None.

FilterChoiceCount

Gets or sets the number of data items to display when filtering data in the Gantt chart.

Declaration

public int FilterChoiceCount { get; set; }

Property Value

Type	Description
System.Int32	An integer value that specifies the number of data items to display when filtering data in the Gantt chart.

Remarks

Use this property to define the number of data items to display when filtering data in the Gantt chart. The value should be specified as a integer.

FilterOperators

Gets or sets the custom filter operators used by the component.

Declaration

public List<object> FilterOperators { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Object>	A list of filter operators that can be used for custom filtering.

Remarks

The FilterOperators property allows you to define a custom set of filter operators that can be used for filtering data in the component.

ForeignKeyData

Gets the foreign data objects used by the GanttChart.

Declaration

public IDictionary<string, IEnumerable<object>> ForeignKeyData { get; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Collections.Generic.IEnumerable<System.Object>>	A dictionary of foreign data objects where the key represents the identifier for the foreign data and the value represents the collection of objects associated with that foreign data.

Remarks

The ForeignKeyData property is used to provide additional data for the GanttChart that is related to the primary data being displayed.

Form

Gets or sets the custom filter operators used by the component.

Declaration

public DOM Form { get; set; }

Property Value

Type	Description
DOM	A list of filter operators that can be used for custom filtering.

Remarks

The FilterOperators property allows you to define a custom set of filter operators that can be used for filtering data in the component.

FromColumns

Defines the collection of columns to be moved.

Declaration

public List<GridColumn> FromColumns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GridColumn>	A System.Collections.Generic.List<> of GridColumn objects that specifies the collection of columns to be moved in the Gantt chart.

Remarks

Use this property to define the collection of columns that should be moved in the Gantt chart. The columns are represented as GridColumn objects.

Index

Gets or sets the index of the added row.

Declaration

public int Index { get; set; }

Property Value

Type	Description
System.Int32	An integer value representing the index of the added row.

Remarks

The Index property represents the position of the added row within a collection or data structure. It should be set to an integer value that indicates the index of the added row.

ModifiedRecords

Defines the modified records in the GanttChart.

Declaration

public List<IDictionary<string, object>> ModifiedRecords { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<System.Collections.Generic.IDictionary<System.String, System.Object>>	A list of modified records in the GanttChart.

Remarks

The ModifiedRecords property represents a collection of records that have been modified in the GanttChart. Each record is represented as a dictionary of field names and corresponding values.

ModifiedTaskData

Defines the modified task data objects in the GanttChart.

Declaration

public List<TValue> ModifiedTaskData { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<TValue>	A list of modified task data objects in the GanttChart.

Remarks

The ModifiedTaskData property represents a collection of task data objects that have been modified in the GanttChart. Each task data object corresponds to a modified task in the GanttChart.

MovableForm

Gets or sets the movable table form element associated with the GanttChart.

Declaration

public DOM MovableForm { get; set; }

Property Value

Type	Description
DOM	The DOM element representing the movable table form associated with the GanttChart.

Remarks

The MovableForm property allows you to specify the movable table form element associated with the GanttChart.

PredecessorOffSetValidation

Gets or sets whether to restrict taskbar dragging beyond a predecessor value.

Declaration

public bool PredecessorOffSetValidation { get; set; }

Property Value

Type	Description
System.Boolean	true if taskbar dragging should be restricted to a date less than the predecessor value; otherwise, false. The default value is false.

Remarks

The PredecessorOffSetValidation property determines whether the dragging of taskbars in the GanttChart component should be restricted based on the value of their predecessors. When PredecessorOffSetValidation is set to true, the GanttChart component will enforce a rule that prevents taskbars from being dragged to a date that is later than the date of their predecessors.

PreviousData

Gets the previous data object for the current operation in the GanttChart.

Declaration

public TValue PreviousData { get; }

Property Value

Type	Description
TValue	The previous data object that represents the state before the current operation in the GanttChart.

Remarks

The PreviousData property provides access to the data object that represents the state before the current operation in the GanttChart. This can be useful for tracking changes and performing actions based on the previous data. The type of the PreviousData object should be specified by the generic parameter TValue.

PreviousPage

Defines the previous page number.

Declaration

public int PreviousPage { get; set; }

Property Value

Type	Description
System.Int32	An integer value that specifies the number of the previous page in the Gantt chart.

PrimaryKeys

Gets the primary keys used in the GanttChart.

Declaration

public string[] PrimaryKeys { get; }

Property Value

Type	Description
System.String[]	An array of string values representing the primary keys used in the GanttChart.

Remarks

The PrimaryKeys property defines the primary keys used in the GanttChart to uniquely identify records. It should be set to an array of string values, where each string represents a primary key column name. Multiple primary keys can be specified if the GanttChart uses a composite key. The primary key columns are used for operations such as data retrieval, updates, or deletions in the GanttChart.

PrimaryKeyValue

Gets the primary key value for the current record in the GanttChart.

Declaration

public object PrimaryKeyValue { get; }

Property Value

Type	Description
System.Object	The value of the primary key that uniquely identifies the current record in the GanttChart.

Remarks

The PrimaryKeyValue property provides access to the value of the primary key that uniquely identifies the current record in the GanttChart. This can be useful for performing operations such as data retrieval, updates, or deletions based on the primary key value. The type of the PrimaryKeyValue property should match the data type of the primary key column in the underlying data source.

RequestType

Gets the current action being performed in the GanttChart.

Declaration

public Action RequestType { get; }

Property Value

Type	Description
Action	The Action enum value representing the current action in the GanttChart.

Remarks

The RequestType property represents the current action being performed in the GanttChart.

Row

Defines the added row.

Declaration

public DOM Row { get; set; }

Property Value

Type	Description
DOM	A DOM object representing the row element.

RowData

Gets or sets the record object associated with the row in the GanttChart.

Declaration

public TValue RowData { get; set; }

Property Value

Type	Description
TValue	The record object that represents the data associated with the row in the GanttChart.

Remarks

The RowData property provides access to the record object associated with the row in the GanttChart.

RowIndex

Gets the row index of the edited row in the GanttChart.

Declaration

public int RowIndex { get; }

Property Value

Type	Description
System.Int32	An integer value representing the row index of the edited row.

Remarks

The RowIndex property represents the index of the row that is being edited in the GanttChart. It should be set to an integer value that indicates the position of the edited row.

SearchString

Gets or sets the string value used for searching in the GanttChart.

Declaration

public string SearchString { get; set; }

Property Value

Type	Description
System.String	The string value used for performing search operations in the GanttChart.

Remarks

The SearchString property represents the value that is used for searching within the GanttChart. It should be set to a string value that specifies the search criteria.

SelectedRow

Gets or sets the index of the selected row in the GanttChart.

Declaration

public int SelectedRow { get; set; }

Property Value

Type	Description
System.Int32	An integer value representing the index of the selected row in the GanttChart.

Remarks

The SelectedRow property represents the index of the row that is currently selected in the GanttChart. It should be set to an integer value that indicates the position of the selected row.

Target

Defines the target for dialog.

Declaration

public DOM Target { get; set; }

Property Value

Type	Description
DOM	The DOM element that serves as the target for the dialog.

TaskBarEditAction

Gets the TaskBar Edit Action for the GanttChart component.

Declaration

public string TaskBarEditAction { get; }

Property Value

Type	Description
System.String	Accepts a string value that defines the TaskBar Edit Action.

Remarks

The TaskBarEditAction property defines the action to be performed when editing the taskbar in the GanttChart component. It accepts a string value that represents the TaskBar Edit Action.

ToColumn

Gets or sets the destination column to place reordered columns.

Declaration

public GridColumn ToColumn { get; set; }

Property Value

Type	Description
GridColumn	A GridColumn object that specifies the destination column to place reordered columns in the Gantt chart.

Remarks

Use this property to define the destination column where the reordered columns should be placed in the Gantt chart. The destination column is represented as a GridColumn object.

Tr

Defines the selected rows for delete.

Declaration

public List<DOM> Tr { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<DOM>	A list of DOM elements that represent the rows to be deleted in the table.

Type

Gets or sets the type of event in the GanttChart.

Declaration

public string Type { get; set; }

Property Value

Type	Description
System.String	The string value representing the type of event.

Remarks

The Type property represents the type of event that is being handled in the GanttChart. It should be set to a string value that describes the specific type of event.

ValidateMode

Gets or sets the validation mode for predecessor relationships in the GanttChart component.

Declaration

public ValidateMode ValidateMode { get; set; }

Property Value

Type	Description
ValidateMode	An instance of the ValidateMode enumeration that specifies the validation mode for predecessor relationships.

Remarks

The ValidateMode property defines the validation mode for predecessor relationships in the GanttChart component. It should be set to a value from the ValidateMode enumeration, which includes options such as "Auto" or "Manual".

VisibleColumns

Gets or sets the list of visible columns in the column chooser.

Declaration

public List<GridColumn> VisibleColumns { get; set; }

Property Value

Type	Description
System.Collections.Generic.List<GridColumn>	A System.Collections.Generic.List<> of GridColumn objects that specifies the list of visible columns in the column chooser of the Gantt chart.

Remarks

Use this property to define the list of visible columns that appear in the column chooser of the Gantt chart. The columns are represented as GridColumn objects.