@docsvision/webclient/Platform/Dropdown.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

/// <reference types="react" />
import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
import { DropdownImpl, IDropdownState } from "@docsvision/webclient/Platform/DropdownImpl";
import { InputBasedControl, InputBasedControlParams } from "@docsvision/webclient/System/InputBasedControl";
import { $EditOperationStore, $LayoutInfo } from "@docsvision/webclient/System/LayoutServices";
import { IBindingResult } from "@docsvision/webclient/System/IBindingResult";
import { BasicApiEvent, CancelableApiEvent } from "@docsvision/webclient/System/ApiEvent";
import { IEventArgs } from "@docsvision/webclient/System/IEventArgs";
import { $LabelWidth } from '@docsvision/webclient/System/$LabelWidth';
import { Optional } from '@docsvision/web/core/services';
/**
 * Содержит публичные свойства элемента управления [Раскрывающийся список]{@link Dropdown}.
 */
export declare class DropdownParams extends InputBasedControlParams<string> {
    /** Стандартный CSS класс со стилями элемента управления */
    standardCssClass?: string;
    /** Дополнительный CSS класс для раскрывающегося списка */
    customCssForPopover?: string;
    /** Список элементов, доступных для выбора */
    items: GenModels.Element[];
    /** Флаг развернутости Раскрывающегося списка */
    isCollapsed?: boolean;
    /** Доступно ли нулевое значение для выбора. Как правило значение сооветствует настройкам привязанного поля карточки в метаданных. */
    isEmptyKeyAllowed?: boolean;
    /** Событие возникает при сворачивании Раскрывающегося списка. */
    collapsing?: CancelableApiEvent<IEventArgs>;
    /** Событие возникает после сворачивания Раскрывающегося списка. */
    collapsed?: BasicApiEvent<IEventArgs>;
    /** Событие возникает при разворачивании Раскрывающегося списка. */
    expanding?: CancelableApiEvent<IEventArgs>;
    /** Событие возникает после разворачивания Раскрывающегося списка. */
    expanded?: BasicApiEvent<IEventArgs>;
    elementContentRenderFunc?: (element: GenModels.Element) => JSX.Element;
    services?: $EditOperationStore & $LayoutInfo & Optional<$LabelWidth>;
    /** Статичное смещение всплывающего окна Popover от вычисленного положения по оси Y в пикселях. */
    yShift?: number;
}
/**
 * Класс элемента управления Раскрывающийся список.
 */
export declare class Dropdown extends InputBasedControl<string, DropdownParams, IDropdownState> {
    protected createParams(): DropdownParams;
    static ControlTypeName: string;
    /** Возвращает численное значение выбранного элемента. */
    get valueCode(): number;
    set valueCode(code: number);
    protected getServices(): $EditOperationStore & $LayoutInfo & Partial<$LabelWidth>;
    private set setElements(value);
    private get getElements();
    private set setBinding(value);
    private set setDefault(value);
    protected getBindings(): IBindingResult<unknown>[];
    protected getDefault(): string;
    onSaved(): Promise<void>;
    /** @internal */
    protected createImpl(): DropdownImpl;
}