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

Type definitions for DocsVision WebClient scripts and extensions.

import { FileListAttachedElements } from "@docsvision/webclient/BackOffice/FileListAttachElements";
import { GenModels } from "@docsvision/webclient/Generated/DocsVision.WebClient.Models";
import { CommentFileParams } from "@docsvision/webclient/Platform/CommentFile";
import { BaseControlState } from "@docsvision/webclient/System/BaseControl";
import { BaseControlImpl } from "@docsvision/webclient/System/BaseControlImpl";
import { IBindingResult } from "@docsvision/webclient/System/IBindingResult";
import { RequestHelper } from "@docsvision/webclient/System/RequestHelper";
import { IValidationParams } from "@docsvision/webclient/System/IValidationParams";
import { IValidationResult } from "@docsvision/webclient/System/IValidationResult";
import React from "react";
import { ICardOpenedByWebDavMessage } from "@docsvision/webclient/BackOffice/FileListControlImpl";
import { IRealTimeCommunicationMessage } from "@docsvision/webclient/System/IRealTimeCommunicationMessage";
/** @internal */
export interface ICommentFileState extends BaseControlState, CommentFileParams {
    menuExpanded: boolean;
    saveHelper: RequestHelper;
    validationMessage: string;
    bindingInfo: IBindingResult<GenModels.CommonFileModel>;
    lastSelectedFile: File;
}
export interface CommentFileState extends ICommentFileState {
}
/** @internal */
export declare class CommentFileImpl extends BaseControlImpl<CommentFileParams, ICommentFileState> {
    fileUploadAttach: FileListAttachedElements;
    commentFileNameMaxLength: number;
    openedInEditorFiles: string[];
    constructor(props: CommentFileParams, state: ICommentFileState);
    setValue(value: GenModels.CommonFileModel, forceUpdate?: boolean): Promise<unknown>;
    protected setValueInternal(value: GenModels.CommonFileModel): Promise<void>;
    set value(newVal: GenModels.CommonFileModel);
    get value(): GenModels.CommonFileModel;
    componentDidMount(): void;
    componentWillUnmount(): void;
    protected onDocumentChangedAndSavedByWebdav: (msg: IRealTimeCommunicationMessage<ICardOpenedByWebDavMessage>) => void;
    protected onDocumentClick: (e: MouseEvent) => void;
    getLinkUrl(cardId: string): string;
    openMenu: () => void;
    closeMenu: () => void;
    toggleMenu: () => void;
    openFilePreview: () => void;
    removeFile: () => void;
    onOpenMenuClick: () => Promise<void>;
    getVisibilityOpenFileButton(fileId: string): boolean;
    private getOpenFileRequestData;
    private sendOpenFileRequest;
    private sendOpenFileDvWebTool;
    onDownloadMenuClick: () => Promise<void>;
    getDownloadLink(): string;
    onUploadMenuClick: () => void;
    onDeleteMenuClick: () => void;
    onTextClick: () => void;
    openFileSelectDialog(): Promise<void>;
    validate(params: IValidationParams): IValidationResult;
    onMenuClick: () => void;
    get hasValue(): boolean;
    get isLoading(): boolean;
    get isMenuAvailable(): boolean;
    get isTextClickable(): boolean;
    get isPreviewMenuAvailable(): boolean;
    protected renderValidationMessage(): JSX.Element;
    protected get editAvailable(): boolean;
    protected getCssClass(): string;
    protected getTextTabIndex(): 0 | -1;
    protected onTextKeyDown: (event: React.KeyboardEvent) => void;
    protected onMenuKeyDown: (event: React.KeyboardEvent) => void;
    protected initFileUpload(attach: FileListAttachedElements): void;
    protected onFilesAdded(attach: FileListAttachedElements, e: any, data: any): Promise<void>;
    setFile(file: File): Promise<void>;
    protected renderUploadForm(attach: FileListAttachedElements): JSX.Element;
    protected renderLabel(): JSX.Element;
    /**
     * Renders settings menu and its icon to open menu
     */
    protected renderSettingsMenu(): JSX.Element;
    /**
     * Renders label value
     */
    protected renderValue(): JSX.Element;
    renderControl(): JSX.Element;
}