XamWebGrid Extended Support Details

XamWebGrid has extended support for the following events:
  • ColumnSorted, used to track end user behavior of sorting columns
  • ColumnResized, used to track end user behavior of resizing columns
  • ColumnDragEnded, used to track end user behavior of column moving (reordering of columns)
  • Filtered, used to track end user behavior of filtering data
  • PageIndexChanged, used to track end user behavior of navigating on different pages of paged data

The ActionValue parameter from Service Oriented Analytics Protocol Specification 1.0 specification is populated with the following value:

{ "Control":"XamWebGrid","Event":"[EventName]",[Event Specific Properties] }

As you might notice, this is a standard JSON format.

Below is a list of properties specified in greater detail:
  • Control property is always set to XamWebGrid
  • Event property is set to the value of the extended support event that has occurred (ColumnSorted, ColumnResized, ColumnDragEnded, Filtered, or PageChanged )

Below is a list of the event-specific properties that are added to the JSON string:
  • ColumnSorted
    • ColumnKey indicates the Key property of column being sorted
    • NewSortDirection has value of {[Ascending|Descending|None]}
    • PreviousSortDirection has value of {[Ascending|Descending|None]}
  • ColumnResized. This event might raise for more than one column at once, so there is a list (Columns) of repeating properties for each column that has changed:
    • {[ColumnKey]} - the Key property of column being sorted
    • {[ActualWidth]} - the resulted Width of column, after resizing
    • The result JSON string will look similar to this:
      • { "Control":"XamWebGrid","Event":"ColumnResized","Columns":{ "Column1": "120","Column2":"80","Column3":"200" } }
  • ColumnDragEnded
    • Column - this property will have the value of the Key property of column that have been moved
  • Filtered This event might raise for more than one column at once, so there is a list (Columns) of repeating properties for each column that has changed:
    • {[FiledName]} - the property name of underlying data source object
    • {[FilterOperand FilterValue]} - FilterOperand, such as "StartsWith", "Contains", "DoesNotContain", "Equals", ets, and the filter value that is netered by end user
    • The result JSON string will look similar to this:
      • { "Control":"XamWebGrid","Event":"Filtered","Columns":{ "City": "Contains York","Price":"LessThan 1000" } }
  • PageIndexChanged
    • NewPage - indicates the new page index
    • OldPage - indicates the old page index
    • The result JSON string will look similar to this:
      • { "Control":"XamWebGrid","Event":"PageChanged","NewPage": 3, "OldPage": 1 }

Last edited Jun 10, 2010 at 2:10 PM by kmatev, version 9

Comments

No comments yet.