Interface nsIAutoCompleteResultType

Hierarchy

Properties

defaultIndex errorDescription matchCount searchResult searchString

Methods

AddRef QueryInterface Release getCommentAt getFinalCompleteValueAt getImageAt getLabelAt getStyleAt getValueAt isRemovableAt removeValueAt

Properties

Readonly defaultIndex

defaultIndex: number

Index of the default item that should be entered if none is selected

Readonly errorDescription

errorDescription: string

A string describing the cause of a search failure

Readonly matchCount

matchCount: number

The number of matches

Readonly searchResult

searchResult: number

The result of the search

Readonly searchString

searchString: string

indicates success with matches and that the search is still ongoing The original search string

Methods

AddRef

  • Increases the reference count for this interface. The associated instance will not be deleted unless the reference count is returned to zero.

    Returns

    The resulting reference count.

    Returns number

QueryInterface

  • Parameters

    • aIID: object
    • Optional aInstancePtr: object

    Returns any

  • A run time mechanism for interface discovery.

    Returns

    NS_OK if the interface is supported by the associated instance, NS_NOINTERFACE if it is not.

    aInstancePtr must not be null.

    Parameters

    • aIID: object

      [in] A requested interface IID

    • aInstancePtr: object

      [out] A pointer to an interface pointer to receive the result.

    Returns void

Release

  • Decreases the reference count for this interface. Generally, if the reference count returns to zero, the associated instance is deleted.

    Returns

    The resulting reference count.

    Returns number

getCommentAt

  • Get the comment of the result at the given index

    Parameters

    • index: number

    Returns string

getFinalCompleteValueAt

  • Get the final value that should be completed when the user confirms the match at the given index.

    Parameters

    • index: number

    Returns string

getImageAt

  • Get the image of the result at the given index

    Parameters

    • index: number

    Returns string

getLabelAt

  • This returns the string that is displayed in the dropdown

    Parameters

    • index: number

    Returns string

getStyleAt

  • Get the style hint for the result at the given index

    Parameters

    • index: number

    Returns string

getValueAt

  • Get the value of the result at the given index

    Parameters

    • index: number

    Returns string

isRemovableAt

  • True if the value at the given index is removable.

    Parameters

    • rowIndex: number

    Returns bool

removeValueAt

  • Remove the value at the given index from the autocomplete results.

    Parameters

    • rowIndex: number

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc