Filters result based on given field name with multiple value
fieldname
Name of the field.
values
Values of the filter.
fieldtype
Type of the field.
filtertype
Type of the filter.
example
// Filters the result with the given values
grid.FilterResultWithMultipleValues('Title', ['Moby', 'Don'], SobyFieldTypes.Text, SobyFilterTypes.Contains)
Parameters
fieldName: any
values: any
fieldType: any
filterType: any
shouldBeClearedOnUIFilterAction: boolean
Returns void
FocusToFirstItem
FocusToFirstItem(): void
Focuses to the first item
example
// Focuses to the first item
grid.FocusToFirstItem();
States whether it is an edit item form or new item form.
rowid
Identifier of the row.
example
// Populates new item form
grid.PopulateEditControlsOnNewEditForm(false, null);
example
// Populates edit item form for row id as soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b
grid.PopulateEditControlsOnNewEditForm(true, 'soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b');
Parameters
isEditForm: boolean
rowId: string
Returns void
PopulateGridData
PopulateGridData(items: any): void
Populates the grid data
items
Data items which returned from the service.
example
// Populates the grid with the given items
grid.PopulateGridData(items);
Parameters
items: any
Returns void
PopulateGroupByRow
PopulateGroupByRow(itemIndex: number, item: any, row: any): any
// Saves edited item with row id as soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b.
grid.SaveItemDetail('soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b');
Parameters
rowId: string
Returns void
SelectAllRows
SelectAllRows(): void
Returns void
SelectCell
SelectCell(rowID: any, cellIndex: any): void
Selects the cell
rowid
Identifier of the row.
cellindex
Index of the cell.
example
// Selects the cell with given row identifier and cell index
grid.SelectCell("soby_griddatarow_fdc30fcf-caee-eec7-a95f-16589d619c9c", 3);
Parameters
rowID: any
cellIndex: any
Returns void
SelectDetailGridTab
SelectDetailGridTab(rowid: any, index: any): void
Selects the detail grid tab
rowid
Identifier of the row.
index
Index of the tab.
example
// Populates the detail grid
grid.SelectDetailGridTab('soby_griddatarow_e63bc6df-9a42-a52e-86a5-3d6665cd0bc0', '0');
Parameters
rowid: any
index: any
Returns void
SelectRow
SelectRow(rowID: any): void
Selects the row
rowid
Identifier of the row.
example
// Selects the row with given row identifier
grid.SelectRow("soby_griddatarow_fdc30fcf-caee-eec7-a95f-16589d619c9c");
Parameters
rowID: any
Returns void
SelectRowByIndex
SelectRowByIndex(rowIndex: any): void
Selects the row
rowindex
Index of the row.
example
// Selects the row with given row index
grid.SelectRow(1);
Represents a webgrid.
// Creates the grid object let bookDataSourceBuilder = new soby_WSBuilder(); bookDataSourceBuilder.Filters = new SobyFilters(false); bookDataSourceBuilder.AddSchemaField("Id", SobyFieldTypes.Number, null); bookDataSourceBuilder.AddSchemaField("Title", SobyFieldTypes.Text, null); bookDataSourceBuilder.AddSchemaField("Year", SobyFieldTypes.Number, null); bookDataSourceBuilder.AddSchemaField("Price", SobyFieldTypes.Number, null); bookDataSourceBuilder.AddSchemaField("Genre", SobyFieldTypes.Text, null); bookDataSourceBuilder.AddSchemaField("AuthorId", SobyFieldTypes.Lookup, { ModelName: "Author", ValueFieldType: SobyFieldTypes.Number, ValueFieldName: "Id", TitleFieldName: "Name", ReadTransport: new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Authors", "json", "application/json; charset=utf-8", "GET")}); let bookService = new soby_WebServiceService(bookDataSourceBuilder); bookService.Transport.Read = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books", "json", "application/json; charset=utf-8", "GET"); bookService.Transport.Add = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books", "json", "application/json; charset=utf-8", "POST"); bookService.Transport.Update = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books(#key)", "json", "application/json; charset=utf-8", "PUT"); bookService.Transport.Delete = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books(#key)", "json", "application/json; charset=utf-8", "DELETE");
let bookGrid = new soby_WebGrid("#soby_BooksDiv", "Books", bookService, "There is no record found."); bookGrid.AddKeyField("Id"); bookGrid.AddColumn("Title", "Title", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("Year", "Year", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("Price", "Price", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("Genre", "Genre", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("AuthorId", "Author", SobyShowFieldsOn.All, function (item) { return item.Author.Name; }, null, true, true, true, null);
bookGrid.Initialize(true);