Interface KbSearchControl

Interface for a knowledge base search control

Hierarchy

Xrm.Controls.Control
- KbSearchControl

Index

Methods

addOnPostSearch addOnResultOpened addOnSelection getControlType getLabel getName getParent getSearchQuery getSelectedResults getTotalResultCount getVisible openSearchResult removeOnPostSearch removeOnResultOpened removeOnSelection setLabel setSearchQuery

Methods

addOnPostSearch

addOnPostSearch(handler): void
Adds an event handler to the PostSearch event.
Parameters
- handler: PostSearchEventHandler
Returns void

See
External Link: addOnPostSearch (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3904

addOnResultOpened

addOnResultOpened(handler): void
Adds an event handler to the OnResultOpened event.
Parameters
- handler: ResultOpenedEventHandler
Returns void

See
External Link: addOnResultOpened (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3910

addOnSelection

addOnSelection(handler): void
Adds an event handler to the OnSelection event.
Parameters
- handler: SelectionEventHandler
Returns void

See
External Link: addOnSelection (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3916

getControlType

getControlType(): string
Gets the controls type.

Returns string
The control type.

Values returned are:
- standard
- iframe
- lookup
- optionset
- subgrid
- webresource
- notes
- timercontrol
- kbsearch
- quickform (see ui.QuickForm)
- customcontrol: . (A custom control for mobile phone and tablet clients).
- customsubgrid: . (A custom dataset control for mobile phone and tablet clients).
Inherited from Control.getControlType
- Defined in node_modules/@types/xrm/index.d.ts:3262

getLabel

getLabel(): string
Gets the label.

Returns string
The label.
Inherited from Control.getLabel
- Defined in node_modules/@types/xrm/index.d.ts:3045

getName

getName(): string
Gets the name of the control on the form.

Returns string
The name of the control.

Remarks
The name assigned to a control is not determined until the form loads. Changes to the form may change the name assigned to a given control. When you use the control getName method the name of the first control will be the same as the name of the attribute. The second instance of a control for that attribute will be "1". The pattern +N will continue for each additional control added to the form for a specific attribute. When a form displays a business process flow control in the header, additional controls will be added for each attribute that is displayed in the business process flow. These controls have a unique name like the following: header_process_.
Inherited from Control.getName
- Defined in node_modules/@types/xrm/index.d.ts:3278

getParent

getParent(): Xrm.Controls.Section
Gets a reference to the Section parent of the control.

Returns Xrm.Controls.Section
The parent Section.
Inherited from Control.getParent
- Defined in node_modules/@types/xrm/index.d.ts:3284

getSearchQuery

getSearchQuery(): string
Gets the text used as the search criteria for the knowledge base management control.

Returns string

See
External Link: getSearchQuery (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3922

getSelectedResults

getSelectedResults(): KbSearchResult
Gets the currently selected result of the search control. The currently selected result also represents the result that is currently open.

Returns KbSearchResult

See
External Link: getSelectedResults (Client API Reference)
- Defined in node_modules/@types/xrm/index.d.ts:3928

getTotalResultCount

getTotalResultCount(): number
Gets the count of results found in the search control.

Returns number
The count of the search result.

See
External Link: getTotalResultCount (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3935

getVisible

getVisible(): boolean
Gets the visibility state.

Returns boolean
true if the tab is visible, otherwise false.
Inherited from Control.getVisible
- Defined in node_modules/@types/xrm/index.d.ts:3100

openSearchResult

openSearchResult(resultNumber, mode?): boolean
Opens a search result in the search control by specifying the result number.
Parameters
- resultNumber: number
  
  Numerical value specifying the result number to be opened. Result number starts from 1.
- Optional mode: OpenSearchResultMode
  
  Specify "Inline" or "Popout". "Inline" mode opens the result inline either in the reading pane of the control or in a reference panel tab in case of reference panel. "Popout" mode opens the result in a pop-out window.
Returns boolean
Status of opening the specified search result. Returns 1 if successful; 0 if unsuccessful. The method will return -1 if the specified resultNumber value is not present, or if the specified mode value is invalid.

See
External Link: openSearchResult (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3944

removeOnPostSearch

removeOnPostSearch(handler): void
Removes an event handler from the PostSearch event.
Parameters
- handler: PostSearchEventHandler
  
  The function to remove from the PostSearch event.
Returns void

See
External Link: removeOnPostSearch (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3951

removeOnResultOpened

removeOnResultOpened(handler): void
Removes an event handler from the OnResultOpened event.
Parameters
- handler: ResultOpenedEventHandler
  
  The function to remove from the OnResultOpened event.
Returns void

See
External Link: removeOnResultOpened (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3958

removeOnSelection

removeOnSelection(handler): void
Removes an event handler from the OnResultSelection event.
Parameters
- handler: SelectionEventHandler
  
  The function to remove from the OnSelection event.
Returns void

See
External Link: removeOnSelection (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3965

setLabel

setLabel(label): void
Sets the label.
Parameters
- label: string
  
  The label.
Returns void
Inherited from Control.setLabel
- Defined in node_modules/@types/xrm/index.d.ts:3051

setSearchQuery

setSearchQuery(searchString): void
Sets the text used as the search criteria for the knowledge base search control.
Parameters
- searchString: string
  
  The text for the search query.
Returns void

See
External Link: setSearchQuery (Client API reference)
- Defined in node_modules/@types/xrm/index.d.ts:3972

Interface KbSearchControl

Hierarchy

Index

Methods

Methods

addOnPostSearch

Parameters

handler: PostSearchEventHandler

Returns void

See

addOnResultOpened

Parameters

handler: ResultOpenedEventHandler

Returns void

See

addOnSelection

Parameters

handler: SelectionEventHandler

Returns void

See

getControlType

Returns string

getLabel

Returns string

getName

Returns string

Remarks

getParent

Returns Xrm.Controls.Section

getSearchQuery

Returns string

See

getSelectedResults

Returns KbSearchResult

See

getTotalResultCount

Returns number

See

getVisible

Returns boolean

openSearchResult

Parameters

resultNumber: number

Optional mode: OpenSearchResultMode

Returns boolean

See

removeOnPostSearch

Parameters

handler: PostSearchEventHandler

Returns void

See

removeOnResultOpened

Parameters

handler: ResultOpenedEventHandler

Returns void

See

removeOnSelection

Parameters

handler: SelectionEventHandler

Returns void

See

setLabel

Parameters

label: string

Returns void

setSearchQuery

Parameters

searchString: string

Returns void

See

Settings

Member Visibility

Theme

On This Page

`Optional` mode: OpenSearchResultMode