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

Type definitions for DocsVision WebClient scripts and extensions.

import { FolderDataContextImpl, IFolderDataContextState } from "@docsvision/webclient/Platform/FolderDataContextImpl";
import { Panel, PanelParams } from "@docsvision/webclient/Platform/Panel";
import { GenModels } from '@docsvision/webclient/Generated/DocsVision.WebClient.Models';
import { $CurrentFolder } from '@docsvision/webclient/Platform/$CurrentFolder';
import { ICommonFolderInfo } from '@docsvision/webclient/Platform/ICommonFolderInfo';
import { IFolderDataLoadingPlugin } from '@docsvision/webclient/Platform/IFolderDataLoadingPlugin';
import { $CurrentLocation } from '@docsvision/webclient/System/LayoutServices';
import { $GridController } from '@docsvision/webclient/Generated/DocsVision.WebClient.Controllers';
import { $ApplicationSettings, $DeviceType, $IsIE } from '@docsvision/webclient/StandardServices';
import { $FolderPluginProvider } from '@docsvision/webclient/Platform/$FolderPluginProvider';
import { Optional } from '@docsvision/web/core/services';
import { $WebFrameSearchPanel } from "@docsvision/webclient/Platform/$WebFrameSearchPanel";
import { $LastSearchResponse } from "@docsvision/webclient/System/$LastSearchResponse";
import { $GridOptions } from "@docsvision/webclient/Platform/$GridOptions";
export declare type $FolderDataContextServices = Optional<$CurrentFolder> & $CurrentLocation & $GridController & $DeviceType & $FolderPluginProvider & $WebFrameSearchPanel & $GridOptions & $ApplicationSettings & $IsIE;
/**
 * Содержит публичные свойства элемента управления [Данные папки]{@link FolderDataContext}.
 */
export declare class FolderDataContextParams extends PanelParams {
    /** Стандартный CSS класс со стилями элемента управления */
    standardCssClass?: string;
    /** Режим работы контрола, определяющий откуда следует получать информацию о папке, данные которой необходимо загружать. */
    mode: GenModels.FolderDataContextMode;
    /** В режиме {@see GenModels.FolderDataContextMode.SystemFolder} показывает какая именно системная папка должна использоваться. */
    systemFolder?: GenModels.SystemFolders;
    /** Идентификатор папки, используемый в режиме {@see GenModels.FolderDataContextMode.KnownFolder} в свойстве {@see mode} */
    folderInfo?: ICommonFolderInfo;
    /** Загруженная заранее модель данных папки. */
    gridViewModel?: GenModels.GridViewModel;
    /** Расширения, определяющие набор доступных сервисов и способ загрузки данных папки. */
    plugins?: IFolderDataLoadingPlugin[];
    /** Доступные представления. */
    viewSelection?: string;
    services?: $FolderDataContextServices & $LastSearchResponse;
}
/**
 * Класс элемента управления Данные папки.
 *
 * Добавляет в web-разметку сервисы, для загрузки данных папки и доступа к ним.
 */
export declare class FolderDataContext extends Panel<FolderDataContextParams, IFolderDataContextState> {
    static ControlTypeName: string;
    prepare(): void;
    protected createParams(): FolderDataContextParams;
    protected createImpl(): FolderDataContextImpl;
    private set binding(value);
}