Kvaser CanKing GUI Extensions SDK - v7.5.1
    Preparing search index...

    Interface SelectMessageDialogProps

    Properties of the SelectMessageDialog React component.

    interface SelectMessageDialogProps {
        modal?: boolean;
        nodeIdentifier?: string;
        onClose: () => void;
        onSelect: (message: FrameDefinition, sourceId: string) => void;
        open: boolean;
        parentDialogTitle?: string;
        sourceIdFilter?: string;
    }
    Index

    Properties

    modal? nodeIdentifier? onClose onSelect open parentDialogTitle? sourceIdFilter?

    Properties

    modal?: boolean

    Whether the dialog should be modal or not. Default is false.

    nodeIdentifier?: string

    Optional node identifier to limit the databases to those available on the specified node. If not specified, all databases available in the system will be shown.

    onClose: () => void

    Callback that is called when the dialog is closed.

    onSelect: (message: FrameDefinition, sourceId: string) => void

    Callback that is called when a message is selected. The selected message and source identifier are passed as parameters.

    open: boolean

    If true, the dialog is open.

    parentDialogTitle?: string

    Optional title of the parent dialog to be shown in the title bar as a breadcrumb.

    sourceIdFilter?: string

    The source identifier that will be used to filter messages in the select dialog. Leave undefined if no filtering should be done.

    Settings

    Member Visibility

    On This Page

    Properties