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

Type definitions for DocsVision WebClient scripts and extensions.

import { $LayoutFileController, $LayoutLinksController, $LayoutController, $CardOperationsController, $CardsPresentationController } from "@docsvision/webclient/Generated/DocsVision.WebClient.Controllers";
import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
import { $FileController } from "@docsvision/webclient/Legacy/FileController";
import { CardLinkImpl, ICardLinkState } from "@docsvision/webclient/Platform/CardLinkImpl";
import { IDataChangedEventArgsEx } from "@docsvision/webclient/System/IDataChangedEventArgs";
import { $CardId, $EditOperationStore } from "@docsvision/webclient/System/LayoutServices";
import { IBindingResult } from "@docsvision/webclient/System/IBindingResult";
import { EditMode } from "@docsvision/webclient/System/EditMode";
import { BasicApiEvent, CancelableApiEvent } from "@docsvision/webclient/System/ApiEvent";
import { IEventArgs } from "@docsvision/webclient/System/IEventArgs";
import { IValidationResult } from "@docsvision/webclient/System/IValidationResult";
import { Optional } from "@docsvision/web/core/services";
import { $LabelWidth } from '@docsvision/webclient/System/$LabelWidth';
import { $LayoutManager } from '@docsvision/webclient/System/$LayoutManager';
import { $LinksSearchCards } from '@docsvision/webclient/BackOffice/$LinksSearchCardsService';
import { $Layout } from '@docsvision/webclient/System/$Layout';
import { $FilePreviewServices } from '@docsvision/webclient/Platform/FilePreview';
import { InputBasedControl, InputBasedControlParams } from "@docsvision/webclient/System/InputBasedControl";
/**
 * Публичные свойства для контрола {@link CardLink}.
 */
export declare class CardLinkParams extends InputBasedControlParams<GenModels.CardLinkDataModel> {
    standardCssClass?: string;
    /** Информация о текущей выбранной карточке. */
    value?: GenModels.CardLinkDataModel;
    /** Доступно редактирование значения или нет (согласно операции редактирования). */
    canEdit?: boolean;
    /** Текст метки */
    labelText?: string;
    /** Флаг, определяющий, что метка должна отображаться, когда значение элемента управления не задано: true - отображать, false - не отображать. */
    showEmptyLabel?: boolean;
    /** Определяет какой текст будет отображаться для выбора ссылки, когда ссылка не указана.  */
    emptyText?: string;
    /** Всплывающая подсказка */
    tip?: string;
    /** Возвращает режим редактирования. */
    editMode?: EditMode;
    /** Ограничивать ли ширину заголовка */
    limitWidthLabel?: boolean;
    /** Типы карточек, которые пользователь может выбрать при добавлении ссылки. */
    cardTypes?: GenModels.CardNodeInfo[];
    /** Идентификатор карточки. Параметр необходим только для случая, когда контрол находится вне разметки. */
    cardId?: string;
    /** Отрыто ли меню карточки. */
    menuExpanded?: boolean;
    /** обязательно ли для заполнения */
    required?: boolean;
    searchQueryId?: string;
    folderList?: GenModels.SelectFolderNode[];
    /** Наименование параметра поискового запроса */
    searchQueryParamName?: string;
    /** Задержка поиска (мс) */
    searchDelay?: number;
    /** Минимальное количество символов для поиска */
    searchIndex?: number;
    /** Событие, возникающее перед очисткой значения. */
    linkDeleting?: CancelableApiEvent<IEventArgs>;
    /** Событие, возникающее после очистки значения. */
    linkDeleted?: BasicApiEvent<IEventArgs>;
    /** Событие, возникающее перед открытием окна выбора карточки. */
    windowOpening?: CancelableApiEvent<IEventArgs>;
    /** Событие, возникающее после открытия окна выбора карточки. */
    windowOpened?: BasicApiEvent<IEventArgs>;
    /** Событие, возникающее перед закрытием окна выбора карточки. */
    windowClosing?: CancelableApiEvent<IEventArgs>;
    /** Событие, возникающее после закрытия окна выбора карточки. */
    windowClosed?: BasicApiEvent<IEventArgs>;
    /** Событие возникающее при изменении значения элемента управления. */
    dataChanged?: BasicApiEvent<IDataChangedEventArgsEx<GenModels.CardLinkDataModel>>;
    /** Событие, возникающее перед открытием предпросмотра файла связанной карточки. */
    linkFilePreviewing?: CancelableApiEvent<IEventArgs>;
    /** Событие, возникающее после открытия предпросмотра файла связанной карточки. */
    linkFilePreviewed?: BasicApiEvent<IEventArgs>;
    /** Событие, возникающее перед открытием связанной карточки. */
    linkCardOpening?: CancelableApiEvent<IEventArgs>;
    services?: $FileController & $LayoutFileController & $LayoutLinksController & $LayoutController & Optional<$CardId> & $EditOperationStore & $CardId & Optional<$LabelWidth> & $LayoutManager & $Layout & $FilePreviewServices & $CardOperationsController & Optional<$LinksSearchCards> & $CardsPresentationController;
}
/**
 * Представляет элемент управления для редактирования связанной карточки.
 */
export declare class CardLink extends InputBasedControl<GenModels.CardLinkDataModel, CardLinkParams, ICardLinkState> {
    protected construct(): void;
    componentDidMount(): void;
    protected getServices(): $FileController & $LayoutFileController & $LayoutLinksController & $LayoutController & Partial<$CardId> & $EditOperationStore & $CardId & Partial<$LabelWidth> & $LayoutManager & $Layout & 
import("D:/BuildAgent/work/43698d70d905217f/Bin/TypeScriptDefinitions/System/Services/$LayoutCheckService").$LayoutCheck & 
import("D:/BuildAgent/work/43698d70d905217f/Bin/TypeScriptDefinitions/System/Controls/Layout/LayoutServices").$CardInfo & 
import("D:/BuildAgent/work/43698d70d905217f/Bin/TypeScriptDefinitions/System/Core/RequestProcessing/$RequestManager").$RequestManager & 
import("D:/BuildAgent/work/43698d70d905217f/Bin/TypeScriptDefinitions/StandardServices").$ApplicationSettings & 
import("D:/BuildAgent/work/43698d70d905217f/Bin/TypeScriptDefinitions/System/Services/$FileService").$FileService & 
import("D:/BuildAgent/work/43698d70d905217f/Bin/TypeScriptDefinitions/StandardServices").$DeviceType & Partial<
import("@docsvision/webclient/FilePreview/$FilePreview").$FilePreview> & Partial<
import("D:/BuildAgent/work/43698d70d905217f/Bin/TypeScriptDefinitions/StandardServices").$SiteUrl> & $CardOperationsController & Partial<$LinksSearchCards> & $CardsPresentationController;
    protected createParams(): CardLinkParams;
    protected createImpl(): CardLinkImpl;
    private set binding(value);
    private set cardTypes(value);
    set value(newVal: GenModels.CardLinkDataModel);
    get value(): GenModels.CardLinkDataModel;
    protected getBindings(): IBindingResult<any>[];
    private onDataChanged;
    private get cardLinkImpl();
    validate(params: unknown): IValidationResult[];
    /**
     * Открывает привязанную карточку
     */
    openLinkedCard: () => void;
    /**
     * Открывает предпросмотр файла привязанной карточки
     */
    openFilePreview: () => void;
    /**
     * Открывает модальное окно для выбора карточки, которую мы хотим привязать
     */
    openSelectCardDialog: () => void;
    /**
     * Удаляет привязанную карточку
     */
    deleteLinkedCard: () => void;
}