Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CvSearchPaneCallback

Allows for setting search values on underlying editor model

Hierarchy

Index

Methods

clear

  • clear(): void

clearSearchValues

  • clearSearchValues(): void
  • Reset all filter related values to 'null', leaving 'sort' values intact.

    Returns void

clearSortValues

  • clearSortValues(): void
  • Reset all sort related values to 'null', leaving 'search/filter' values intact.

    Returns void

getPropValueForDisplay

  • getPropValueForDisplay(propName: string): string

getPropValueForEdit

  • getPropValueForEdit(propName: string): string

getSearchValue

  • getSearchValue(propName: any): string
  • Get the current search value (if previously set) for this property name.

    Parameters

    • propName: any

    Returns string

getSearchValueOperation

  • getSearchValueOperation(propName: any): string
  • Get the current search value's operation (if previously set) for this property name.

    Parameters

    • propName: any

    Returns string

getSortValueDirection

  • getSortValueDirection(propName: any): string
  • Get the current search value's sort direction (if previously set) for this property name.

    Parameters

    • propName: any

    Returns string

getSortValuePriority

  • getSortValuePriority(propName: any): string
  • Get the current search value's sort priority (if previously set) for this property name.

    Parameters

    • propName: any

    Returns string

isAscending

  • isAscending(propName: any): boolean
  • Get whether or not the current search value's sort direction is ascending for this property name.

    Parameters

    • propName: any

    Returns boolean

isDescending

  • isDescending(propName: any): boolean
  • Get whether or not the current search value's sort direction is descending for this property name.

    Parameters

    • propName: any

    Returns boolean

openReadMode

openWriteMode

refresh

  • refresh(): void

reopenSearch

  • After a submission, the search model is returned in 'read' mode. To search again, this should be called prior to making any param changes.

    Parameters

    Returns void

saveChanges

  • saveChanges(resultCallback?: CvResultCallback<NavRequest>, navTarget?: string): void

setAscending

  • setAscending(propName: string, sortFieldPriority: number): void
  • Sort the search by the specified property in the ascending direction with priority (defaults to 0, meaning primary sort field).

    Parameters

    • propName: string
    • sortFieldPriority: number

    Returns void

setBinaryPropWithDataUrl

  • setBinaryPropWithDataUrl(name: string, dataUrl: string): void

setBinaryPropWithEncodedData

  • setBinaryPropWithEncodedData(name: string, encodedData: string): void

setDescending

  • setDescending(propName: string, sortFieldPriority: number): void
  • Sort the search by the specified property in the descending direction with priority (defaults to 0, meaning primary sort field).

    Parameters

    • propName: string
    • sortFieldPriority: number

    Returns void

setPropValue

  • setPropValue(name: string, value: any): void

setSearchValue

  • setSearchValue(propName: string, searchValue: string): any
  • Set the 'value' of the search operation for a property(i.e. The 'thing' to be searched on this property). This is the value to run against the accompanying operator

    Parameters

    • propName: string
    • searchValue: string

    Returns any

setSearchValueOperation

  • Set the value of the 'operation' to perform on this property. The valid values are defined by CvSearchValueOperator

    Parameters

    Returns any

setSortValue

  • setSortValue(propName: string, sortDirection: CvSortDirection, sortFieldPriority: number): any
  • Sort the search by the specified property. Set the sort direction CvSortDirection and priority (defaults to 0, meaning primary sort field).

    Parameters

    • propName: string
    • sortDirection: CvSortDirection
    • sortFieldPriority: number

    Returns any

submitSearch

  • Submit the search. If successful, returns search editor model in 'read' mode. The search will be applied when the backing list is refreshed.

    Parameters

    Returns any

suppressEvents

  • suppressEvents(suppressEvents: boolean): void

Generated using TypeDoc