@docsvision/webclient/System/ILayoutParams.d.ts

Type definitions for DocsVision WebClient scripts and extensions.

import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
import { $StandardControllers } from "@docsvision/webclient/Legacy/StandardControllers";
import { $StandardServices } from "@docsvision/webclient/StandardServices";
import { LayoutControl } from '@docsvision/webclient/System/BaseControl';
import { ILayout, SaveCardOptions } from "@docsvision/webclient/System/$Layout";
import { SaveControlDataModelEventArgs } from "@docsvision/webclient/System/Layout";
import { BasicApiEvent, CancelableApiEvent } from "@docsvision/webclient/System/ApiEvent";
import { ICardStateChangingEventArgs } from "@docsvision/webclient/System/ICardStateChangingEventArgs";
import { IEventArgs } from "@docsvision/webclient/System/IEventArgs";
export interface ILayoutSavedEventArgs extends IEventArgs {
    options: SaveCardOptions;
    bindings?: Array<GenModels.BindingsWriteRequest>;
}
export interface ILayoutPrepareSavingEventArgs extends IEventArgs {
    options: SaveCardOptions;
    control?: LayoutControl;
}
export declare type ILayoutBeforeSavingEventArgs = ILayoutPrepareSavingEventArgs;
/**
 * Публичные свойства для контрола {@link Layout}.
 */
export interface ILayoutParams {
    /** Название разметки. */
    readonly layoutName: string;
    /** Владелец разметки. */
    readonly owner?: ILayout;
    /** Дочерние разметки. */
    readonly childLayouts?: ILayout[];
    /** Событие возникает при открытии карточки. */
    cardOpening?: CancelableApiEvent<IEventArgs>;
    /** Событие возникает после открытия карточки. */
    cardOpened?: BasicApiEvent<IEventArgs>;
    /** Событие возникает при сохранении карточки после получения значения элементов управления. */
    cardSaving?: CancelableApiEvent<SaveControlDataModelEventArgs>;
    /** Событие возникает при сохранении карточки, до получения значения элементов управления. */
    prepareCardSaving?: CancelableApiEvent<ILayoutPrepareSavingEventArgs>;
    /** Событие возникает после сохранения карточки. */
    cardSaved?: CancelableApiEvent<ILayoutSavedEventArgs>;
    /** Событие возникает, если при сохранении карточки возникли ошибки. */
    cardSaveFailed?: BasicApiEvent<IEventArgs>;
    /** Событие возникает перед изменением состояния карточки. */
    cardStateChanging?: CancelableApiEvent<ICardStateChangingEventArgs>;
    /** Событие возникает перед изменением разметки карточки. */
    cardLayoutSwitching?: CancelableApiEvent<IEventArgs>;
    /** Событие возникает перед изменением разметки карточки. */
    layoutWillUnmount?: BasicApiEvent<IEventArgs>;
    services?: $StandardServices & $StandardControllers;
}