ComponentOne GridView for ASP.NET WebForms
In This Topic
    c1gridview jQuery Widget
    In This Topic
    Syntax
    var options; // Type:  jQuery.wijmo.c1gridview.options
    
    // Create a new c1gridview widget
    $(".selector").c1gridview(options);
    
    // Get a previously created c1gridview widget instance
    var widgetInstance; // Type:  jQuery.wijmo.c1gridview
    widgetInstance = $(".selector").data("wijmo-c1gridview");
    function c1gridview() : any;
    Browser Compatibility
    8
    5
    5
    Options
     NameDescription
    public Option  
    public OptionA value indicating whether columns can be moved.  
    public OptionDetermines whether the column width can be increased and decreased by dragging the sizing handle, or the edge of the column header, with the mouse.  
    public Option  
    public OptionDetermines whether the user can make changes to cell contents in the grid. This option is obsolete. Use the editingMode option instead.  
    public OptionDetermines whether the user can move the current cell using the arrow keys.  
    public OptionDetermines whether the grid should display paging buttons. The number of rows on a page is determined by the pageSize option.  
    public OptionDetermines whether the widget can be sorted by clicking the column header.  
    public OptionA value that indicates whether virtual scrolling is allowed. Set allowVirtualScrolling to true when using large amounts of data to improve efficiency. Obsoleted, set the scrollingSettings.virtualization.mode property to "rows" instead.  
    public Option  
    public Option  
    public Option  
    public Option  
    public OptionA value that indicates calendar's options in grid. It works for calendar in inputdate.  
    public Option  
    public Option  
    public OptionAn array of column options.  
    public OptionDetermines behavior for column autogeneration. Possible values are: "none", "append", "merge".  
    public Option  
    public OptionDetermines the culture ID.  
    public OptionA value that indicators the culture calendar to format the text. This option must work with culture option.  
    public OptionAn array of custom user filters. Use this option if you want to extend the default set of filter operators with your own. Custom filters will be shown in the filter dropdown.  
    public OptionDetermines the datasource. Possible datasources include: 1. A DOM table. This is the default datasource, used if the data option is null. Table must have no cells with rowSpan and colSpan attributes. 2. A two-dimensional array, such as [[0, "a"], [1, "b"]]. 3. An array of objects, such as [{field0: 0, field1: "a"}, {field0: 1, field1: "b'}]. 4. A wijdatasource. 5. A wijdataview.  
    public Option  
    public OptionDetermines an action to bring a cell in the editing mode when the editingMode option is set to "cell". Possible values are: "click", "doubleClick", "auto".  
    public OptionDetermines the editing mode. Possible values are: "none", "row", "cell",  
    public OptionDetermines if the exact column width, in pixels, is used.  
    public OptionDetermines the order of items in the filter drop-down list. Possible values are: "none", "alphabetical", "alphabeticalCustomFirst" and "alphabeticalEmbeddedFirst"  
    public Option  
    public OptionDetermines the caption of the group area.  
    public OptionDetermines the indentation of the groups, in pixels.  
    public OptionDetermines whether the position of the current cell is highlighted or not.  
    public OptionDetermines whether hovered row is highlighted or not.  
    public Option  
    public Option  
    public OptionDetermines the action to be performed when the user presses the TAB key.  
    public OptionDetermines the text to be displayed when the grid is loading.  
    public OptionCell values equal to this property value are considered null values. Use this option if you want to change default representation of null values (empty strings) with something else.  
    public OptionDetermines the zero-based index of the current page. You can use this to access a specific page, for example, when using the paging feature.  
    public OptionDetermines the pager settings for the grid including the mode (page buttons or next/previous buttons), number of page buttons, and position where the buttons appear.  
    public OptionNumber of rows to place on a single page. The default value is 10.  
    public OptionA value indicating whether DOM cell attributes can be passed within a data value.  
    public OptionDetermines the scrolling settings.  
    public Option  
    public OptionDetermines which cells, range of cells, columns, or rows can be selected at one time. Possible values are: "none", "singleCell", "singleColumn", "singleRow", "singleRange", "multiColumn", "multiRow" and "multiRange".  
    public OptionA value indicating whether the filter row is visible. Filter row is used to display column filtering interface.  
    public OptionA value indicating whether the footer row is visible. Footer row is used for displaying of tfoot section of original table, and to show totals.  
    public OptionA value indicating whether group area is visible. Group area is used to display headers of groupped columns. User can drag columns from/to group area by dragging column headers with mouse, if allowColMoving option is on.  
    public Option  
    public OptionA value indicating whether the row header is visible.  
    public OptionA value indicating whether a selection will be automatically displayed at the current cell position when the wijgrid is rendered. Set this option to false if you want to prevent wijgrid from selecting the currentCell automatically.  
    public OptionGets or sets the virtual number of items in the wijgrid and enables custom paging. Setting option to a positive value activates custom paging, the number of displayed rows and the total number of pages will be determined by the totalRows and pageSize values.  
    public Option  
    public Option  
    Top
    Events
     NameDescription
    public EventThe afterCellEdit event handler is a function called after cell editing is completed. This function can assist you in completing many tasks, such as in making changes once editing is completed; in tracking changes in cells, columns, or rows; or in integrating custom editing functions on the front end.  
    public EventThe afterCellUpdate event handler is a function that is called after a cell has been updated. Among other functions, this event allows you to track and store the indices of changed rows or columns.  
    public Event  
    public Event  
    public EventThe cellClicked event handler is a function that is called when a cell is clicked. You can use this event to get the information of a clicked cell using the args parameter.  
    public EventThe columnDragged event handler is a function that is called when column dragging has been started. You can use this event to find the column being dragged or the dragged column's location.  
    public EventThe columnDragging event handler is a function that is called when column dragging has been started, but before the wijgrid handles the operation. This event is cancellable.  
    public EventThe columnDropped event handler is a function that is called when a column has been dropped into the columns area.  
    public Event  
    public EventThe columnGrouped event handler is a function that is called when a column has been dropped into the group area.  
    public EventThe columnGrouping event handler is a function that is called when a column is dropped into the group area, but before the wijgrid handles the operation. This event is cancellable.  
    public EventThe columnResized event handler is called when a user has changed a column's size.  
    public Event  
    public EventThe columnUngrouped event handler is called when a column has been removed from the group area.  
    public EventThe columnUngrouping event handler is called when a column has been removed from the group area but before the wjgrid handles the operation. This event is cancellable.  
    public EventThe currentCellChanged event handler is called after the current cell is changed.  
    public EventThe currentCellChanging event handler is called before the cell is changed. You can use this event to get a selected row or column or to get a data row bound to the current cell. This event is cancellable.  
    public EventThe dataLoaded event handler is a function that is called when data is loaded.  
    public EventThe dataLoading event handler is a function that is called when the wijgrid loads a portion of data from the underlying datasource. This can be used for modification of data sent to server if using dynamic remote wijdatasource.  
    public EventThe detailCreating event handler is called when wijgrid requires to create a new detail wijgrid.  
    public EventThe filtered event handler is a function that is called after the wijgrid is filtered.  
    public Event  
    public EventThe filterOperatorsListShowing event handler is a function that is called before the filter drop-down list is shown. You can use this event to customize the list of filter operators for your users.  
    public Event  
    public EventThe groupText event handler is a function that is called when groups are being created and the groupInfo option has the groupInfo.headerText or the groupInfo.footerText options set to "custom". This event can be used to customize group headers and group footers.  
    public EventThe invalidCellValue event handler is a function called when a cell needs to start updating but the cell value is invalid. So if the value in a wijgrid cell can't be converted to the column target type, the invalidCellValue event will fire.  
    public EventThe loaded event handler is a function that is called at the end the wijgrid's lifecycle when wijgrid is filled with data and rendered. You can use this event to manipulate the grid html content or to finish a custom load indication.  
    public EventThe loading event handler is a function that is called at the beginning of the wijgrid's lifecycle. You can use this event to activate a custom load progress indicator.  
    public EventThe pageIndexChanged event handler is a function that is called after the page index is changed, such as when you use the numeric buttons to swtich between pages or assign a new value to the pageIndex option.  
    public EventThe pageIndexChanging event handler is a function that is called before the page index is changed. This event is cancellable.  
    public EventThe rendered event handler is a function that is called when the wijgrid is rendered. Normally you do not need to use this event.  
    public EventThe rendering event handler is a function that is called when the wijgrid is about to render. Normally you do not need to use this event.  
    public EventThe selectionChanged event handler is a function that is called after the selection is changed.  
    public EventThe sorted event handler is a function that is called after the widget is sorted. The allowSorting option must be set to "true" to allow this event to fire.  
    public EventThe sorting event handler is a function that is called before the sorting operation is started. This event is cancellable. The allowSorting option must be set to "true" for this event to fire.  
    Top
    See Also