@docsvision/webclient
Version:
Type definitions for DocsVision WebClient scripts and extensions.
53 lines (52 loc) • 3.43 kB
TypeScript
import { ConfigurableMainMenuContainerButtonImpl, IConfigurableMainMenuContainerButtonState } from "@docsvision/webclient/Platform/ConfigurableMainMenuContainerButtonImpl";
import { $DeviceType } from '@docsvision/webclient/StandardServices';
import { BaseControl, BaseControlParams } from "@docsvision/webclient/System/BaseControl";
import { $Layout } from '@docsvision/webclient/System/$Layout';
import { $ControlStore } from '@docsvision/webclient/System/LayoutServices';
import { $RequestManager } from '@docsvision/webclient/System/$RequestManager';
import { BasicApiEvent } from "@docsvision/webclient/System/ApiEvent";
/**
* Содержит публичные свойства элемента управления {@link ConfigurableMainMenuContainerButton}.
*/
export declare class ConfigurableMainMenuContainerButtonParams extends BaseControlParams {
/** Стандартный CSS класс со стилями элемента управления */
standardCssClass?: string;
/** Текст всплывающей подсказки. */
tip?: string;
/** Имя CSS класса, в котором определен путь к иконке, отображаемой в кнопке. */
iconClass?: string;
/** Открыто меню или нет. */
menuExpanded?: boolean;
/** Доступен ли элемент меню "Настроить панель". */
showBeginConfigurationItem?: boolean;
/** Доступен ли элемент меню "Вернуть настройки по умолчанию". */
showRestoreItem?: boolean;
/** Доступен ли элемент меню "Присоединить папку". */
showAttachFolderItem?: boolean;
/** Доступен ли элемент меню "Обновить дерево папок". */
showRefreshFoldersItem?: boolean;
/** Название контрола с пользовательскими папками */
userFoldersName: string;
/** Название контрола контейнера с настраиваемыми элементами меню */
configurableContainerName: string;
/** Активирован элемент меню "Настроить панель". */
beginConfigurationClicked?: BasicApiEvent<void>;
/** Активирован элемент меню "Вернуть настройки по умолчанию". */
restoreClicked?: BasicApiEvent<void>;
/** Активирован элемент меню "Присоединить папку". */
attachFolderClicked?: BasicApiEvent<void>;
/** Активирован элемент меню "Обновить дерево папок". */
refreshFoldersClicked?: BasicApiEvent<void>;
services?: $ControlStore & $Layout & $RequestManager & $DeviceType;
}
/**
* Добавляет в web-разметку кнопку в виде иконки шестеренки для открытия меню {@link СonfigurableMainMenuContainer}.
*/
export declare class ConfigurableMainMenuContainerButton extends BaseControl<ConfigurableMainMenuContainerButtonParams, IConfigurableMainMenuContainerButtonState> {
/** @internal */
protected createParams(): ConfigurableMainMenuContainerButtonParams;
/** @internal */
protected createImpl(): ConfigurableMainMenuContainerButtonImpl;
/** @internal */
init(): void;
}