// Copyright 2014-2025 VintaSoft LLC. All rights reserved. // This software is protected by International copyright laws. // Any copying, duplication, deployment, redistribution, modification or other // disposition hereof is STRICTLY PROHIBITED without an express written license // granted by VintaSoft LLC. This notice may not be removed or otherwise // altered under any circumstances. // This code may NOT be used apart of the VintaSoft product. // NAMESPACE declare module Vintasoft.Shared { // ===== ENUMS ===== /** * Specifies available pixel formats for each pixel of the image. */ class WebPixelFormatEnumJS extends Vintasoft.Shared.WebEnumItemBaseJS { constructor(value: string); } /** * Specifies available algorithms, which can be used for image scaling or rotation. */ class WebInterpolationModeEnumJS extends Vintasoft.Shared.WebEnumItemBaseJS { constructor(value: string); } /** * Specifies available modes, which define how smoothing (antialiasing) is applied to lines and curves and the edges of filled areas. */ class WebSmoothingModeEnumJS extends Vintasoft.Shared.WebEnumItemBaseJS { constructor(value: string); } /** * Specifies available formats of web images. */ class WebImageTypeEnumJS extends Vintasoft.Shared.WebEnumItemBaseJS { constructor(value: string); } /** * Specifies available types, which define how an XLSX page must be laid out. */ class WebXlsxPageLayoutSettingsTypeEnumJS extends Vintasoft.Shared.WebFlagsEnumItemBaseJS { constructor(value: string); } // ===== STATIC METHODS ===== /** * Sets one class as a inheritor of another class. * @param derivedClass Derived class. * @param parentClass Parent class. */ function extend(derivedClass: object, parentClass: object): void; /** * Creates a deep clone of objects specified as parameters. */ function cloneObject(): object; /** * Returns the device pixel ratio. */ function getDevicePixelRatio(): number; /** * Triggers an event. * @param object Object that should trigger an event. * @param eventName The event name. * @param eventParams The event parameters. */ function triggerEvent(object: object, eventName: string, eventParams: object): void; /** * Triggers an event. * @param object Object that should trigger an event. * @param eventName The event name. */ function triggerEvent(object: object, eventName: string): void; /** * Subscribes one subscriber to an event. * @param object Object that can trigger an event. * @param eventName The event name. * @param eventHandler The event handler. */ function subscribeToEvent(object: object, eventName: string, eventHandler: Function): void; /** * Subscribes one subscriber to an event once. * @param object Object that can trigger an event. * @param eventName The event name. * @param eventHandler The event handler. */ function subscribeToEventOnce(object: object, eventName: string, eventHandler: Function): void; /** * Unsubscribes subscriber from an event of object. * @param object Object that can trigger an event. * @param eventName The event name. * @param eventHandler The event handler. */ function unsubscribeFromEvent(object: object, eventName: string, eventHandler: Function): void; /** * Unsubscribes all subscribers from an event of object. * @param object Object that can trigger an event. * @param eventName The event name. */ function unsubscribeFromEvent(object: object, eventName: string): void; /** * Unsubscribes all subscribers from all events of object. * @param object Object that can trigger an event. */ function unsubscribeFromEvent(object: object): void; // ===== CLASSES ===== /** * Provides the base class for element of enumeration. */ class WebEnumItemBaseJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebEnumItemBaseJS"] class. */ constructor(); // METHODS /** * Returns names of all enumeration elements. */ getAllAvailableNames(): string[]; /** * Returns values of all enumeration elements. */ getAllAvailableValues(): object[]; /** * Returns value of this enumeration element. */ valueOf(): number; /** * Returns name of this enumeration element. */ toString(): string; /** * Determines that this enumeration element is equals to the specified enumeration element. * @param val Name of enumeration element. */ equals(val: string): boolean; /** * Determines that this enumeration element is equals to the specified enumeration element. * @param val Value of enumeration element. */ equals(val: object): boolean; /** * Determines that this enumeration element defines a bit field. */ isFlagged(): boolean; } /** * Provides the base class for element of flags enumeration. */ class WebFlagsEnumItemBaseJS extends Vintasoft.Shared.WebEnumItemBaseJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebFlagsEnumItemBaseJS"] class. */ constructor(); // METHODS /** * Returns this enumeration element (bit field) as an array of sub elements (bit fields). This method has effect only for enumerations that defines bit flags. */ toArray(): Vintasoft.Shared.WebFlagsEnumItemBaseJS[]; /** * Determines that this enumeration element (bit field) contains the specified sub element (bit field). This method has effect only for enumerations that defines bit flags. * @param val Name of enumeration element (bit field). */ contains(val: string): boolean; /** * Determines that this enumeration element (bit field) contains the specified sub element (bit field). This method has effect only for enumerations that defines bit flags. * @param val Value of enumeration element (bit field). */ contains(val: Vintasoft.Shared.WebFlagsEnumItemBaseJS): boolean; /** * Returns new enumeration element (bit field) that is concatenation of this bit field and the specified bit field. This method has effect only for enumerations that defines bit flags. * @param val Name of enumeration element (bit field). */ add(val: string): Vintasoft.Shared.WebFlagsEnumItemBaseJS; /** * Returns new enumeration element (bit field) that is concatenation of this bit field and the specified bit field. This method has effect only for enumerations that defines bit flags. * @param val Value of enumeration element (bit field). */ add(val: Vintasoft.Shared.WebFlagsEnumItemBaseJS): Vintasoft.Shared.WebFlagsEnumItemBaseJS; /** * Returns new enumeration element (bit field) that is difference between this bit field and the specified bit field. * @param val Name of enumeration element (bit field). */ remove(val: string): Vintasoft.Shared.WebFlagsEnumItemBaseJS; /** * Returns new enumeration element (bit field) that is difference between this bit field and the specified bit field. * @param val Value of enumeration element (bit field). */ remove(val: Vintasoft.Shared.WebFlagsEnumItemBaseJS): Vintasoft.Shared.WebFlagsEnumItemBaseJS; /** * Determines that this enumeration element defines a bit field. */ isFlagged(): boolean; } /** * Allows to create enumerations. */ class EnumGenerator { // CONTSRUCTORS /** * Initializes a new instance of the [see= "EnumGenerator"] class. */ constructor(); // METHODS /** * Creates an enumeration class. * @param items Array of objects "name-value" describing enumeration. Each object has following properties:
* @param flagged A value indicating whether enumeration supports bit operations. */ static create(items: object[], flagged: boolean): object; } /** * Provides information about the current environment and platform. */ class WebImagingEnviromentJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebImagingEnviromentJS"] class. */ constructor(); // METHODS /** * Gets the session identifier. */ static get_SessionId(): string; /** * Sets the session identifier. * @param value The session identifier. Identifier can contain only latin letters, numbers, "_" and "-" symbols. */ static set_SessionId(value: string): void; /** * Returns the scroll size for the specified DOM element. * @param element DOM element. */ static get_ScrollSize(element: object): number; /** * Returns the screen resolution, in dots per inch. */ static getScreenDpi(): Vintasoft.Shared.WebResolutionJS; /** * Returns new GUID. */ static guid(): string; } /** * Contains information about the property of object. */ class WebPropertyInfoJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebPropertyInfoJS"] class. * @param shortName Short property name. * @param fullName Fully qualified property name. * @param value Property value. * @param readOnly Indicates whether the property is read-only. * @param refreshFromParent Indicates whether the property value can be changed only using the parent property. */ constructor(shortName: string, fullName: string, value: object, readOnly: boolean, refreshFromParent: boolean); // PROPERTIES /** * Gets the short property name. */ get_ShortName(): string; /** * Gets the fully qualified property name. */ get_FullName(): string; /** * Gets the property value. */ get_Value(): object; /** * Gets a value indicating whether the property is read-only. */ get_ReadOnly(): boolean; /** * Gets an array of nested properties of the property. */ get_Items(): object[]; /** * Gets a value indicating whether the property value can be changed only using the parent property. */ get_RefreshFromParent(): boolean; } /** * Represents a tree structure that contains information about object properties. A tree node is an instance of [see="WebPropertyInfoJS"] class. */ class WebPropertyGridJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebPropertyGridJS"] class. * @param object Source object. * @param objShortName Object short name. * @param objFullName Object full name. * @param blackList Array of object property names, that should not be included in the result structure. */ constructor(object: object, objShortName: string, objFullName: string, blackList: string[]); /** * Initializes a new instance of the [see= "WebPropertyGridJS"] class. * @param object Source object. * @param objShortName Object short name. * @param objFullName Object full name. */ constructor(object: object, objShortName: string, objFullName: string); /** * Initializes a new instance of the [see= "WebPropertyGridJS"] class. * @param object Source object. * @param objShortName Object short name. */ constructor(object: object, objShortName: string); /** * Initializes a new instance of the [see= "WebPropertyGridJS"] class. * @param object Source object. */ constructor(object: object); // PROPERTIES /** * Gets an information about object properties. */ get_ObjectProperties(): Vintasoft.Shared.WebPropertyInfoJS; // METHODS /** * Sets the property value. * @param propertyFullName Fully qualified name of property. * @param newPropertyValue New property value. */ setPropertyValue(propertyFullName: string, newPropertyValue: object): object; /** * Synchronizes values in property grid and values of object whose values are shown in property grid. * @param newGrid New property grid. */ updatePropertyGrid(newGrid: object): object[]; } /** * Represents a web request to a web service. */ class WebRequestJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebRequestJS"] class. * @param actionName Action name. * @param successFunc Function that will be executed if request is executed successfully. * @param errorFunc Function that will be executed if request is failed. * @param ajaxParams Object that contains the request parameters. * @param isAsync A value indicating whether asynchronous request must be created. Default value is True. */ constructor(actionName: string, successFunc: Function, errorFunc: Function, ajaxParams: object, isAsync: boolean); /** * Initializes a new instance of the [see= "WebRequestJS"] class. * @param actionName Action name. * @param successFunc Function that will be executed if request is executed successfully. * @param errorFunc Function that will be executed if request is failed. * @param ajaxParams Object that contains the request parameters. */ constructor(actionName: string, successFunc: Function, errorFunc: Function, ajaxParams: object); /** * Initializes a new instance of the [see= "WebRequestJS"] class. * @param actionName Action name. * @param successFunc Function that will be executed if request is executed successfully. * @param errorFunc Function that will be executed if request is failed. */ constructor(actionName: string, successFunc: Function, errorFunc: Function); /** * Initializes a new instance of the [see= "WebRequestJS"] class. * @param actionName Action name. * @param successFunc Function that will be executed if request is executed successfully. */ constructor(actionName: string, successFunc: Function); /** * Initializes a new instance of the [see= "WebRequestJS"] class. * @param actionName Action name. */ constructor(actionName: string); // PROPERTIES /** * Returns action name. */ get_ActionName(): string; } /** * Represent a composite web request to a web service. */ class WebCompositeRequestJS extends Vintasoft.Shared.WebRequestJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebCompositeRequestJS"] class. * @param requests An array of [see="WebServiceJS"] instances. * @param actionName Action name. */ constructor(requests: Vintasoft.Shared.WebServiceJS, actionName: string); } /** * Provides a base class for web services (API controllers or HTTP handlers). */ class WebServiceJS { // FIELDS /** * The default web service for image rendering. */ static defaultImageService: object; /** * The default web service for managing of image collection. */ static defaultImageCollectionService: object; /** * The default web service for working with files. */ static defaultFileService: WebServiceJS; /** * The default web service for processing of images. */ static defaultImageProcessingService: WebServiceJS; /** * The default web service for converting image files. */ static defaultConverterService: WebServiceJS; /** * The default web service for processing of document images. */ static defaultImageProcessingDocCleanupService: WebServiceJS; /** * The default web service for annotating of images. */ static defaultAnnotationService: WebServiceJS; /** The default web service for working with Office documents. @field @public @static */ static defaultOfficeService: WebServiceJS; /** * The default web service for working with PDF documents. */ static defaultPdfService: WebServiceJS; /** * The default web service for working with barcodes. */ static defaultBarcodeService: WebServiceJS; /** * The default service for working with TWAIN device manager. */ static defaultTwainService: WebServiceJS; /** * The default service for working with DICOM images. */ static defaultDicomService: WebServiceJS; // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebServiceJS"] class. * @param serviceRoute Route to the web service (controller/handler), for example "/vintasoft/api/VintasoftImageApi/". */ constructor(serviceRoute: string); // PROPERTIES /** * Gets a service route. */ get_ServiceRoute(): string; // METHODS /** * Adds request to the web service. * @param request An instance of [see="WebRequestJS"] class. */ addRequest(request: Vintasoft.Shared.WebRequestJS): object; /** * Sends requests to a web service. */ sendRequests(): object[]; /** * Sends a single request to a web service. * @param webRequest An instance of [see="WebRequestJS"] class. */ sendRequest(webRequest: Vintasoft.Shared.WebRequestJS): object; } /** * A web service that represents Web API controller or HTTP handler. */ class WebServiceControllerJS extends Vintasoft.Shared.WebServiceJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebServiceControllerJS"] class. * @param serviceRoute Route to the web API controller or HTTP handler, for example "/vintasoft/api/VintasoftImageApi/". */ constructor(serviceRoute: string); // METHODS /** * Sends a single request to a web service. * @param webRequest An instance of [see="WebRequestJS"] class. */ sendRequest(webRequest: Vintasoft.Shared.WebRequestJS): object; } /** * A web service that represents HTTP handler. */ class WebServiceHandlerJS extends Vintasoft.Shared.WebServiceJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebServiceHandlerJS"] class. * @param serviceRoute Route to the HTTP handler, for example "Handlers/VintasoftImageHandler1.ashx". */ constructor(serviceRoute: string); // METHODS /** * Sends a single request to a web service. * @param webRequest An instance of [see="WebRequestJS"] class. */ sendRequest(webRequest: Vintasoft.Shared.WebRequestJS): object; } /** * Contains image rendering settings. */ class WebRenderingSettingsJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebRenderingSettingsJS"] class. * @param resolution Resolution, in pixels per inch, for image rendering. * @param interpolationMode [see="WebInterpolationModeEnumJS"] for image rendering. * @param smoothingMode [see="WebSmoothingModeEnumJS"] for image rendering. */ constructor(resolution: Vintasoft.Shared.WebResolutionJS, interpolationMode: Vintasoft.Shared.WebInterpolationModeEnumJS, smoothingMode: Vintasoft.Shared.WebSmoothingModeEnumJS); /** * Initializes a new instance of the [see= "WebRenderingSettingsJS"] class. * @param resolution Resolution, in pixels per inch, for image rendering. * @param interpolationMode [see="WebInterpolationModeEnumJS"] for image rendering. */ constructor(resolution: Vintasoft.Shared.WebResolutionJS, interpolationMode: Vintasoft.Shared.WebInterpolationModeEnumJS); /** * Initializes a new instance of the [see= "WebRenderingSettingsJS"] class. * @param resolution Resolution, in pixels per inch, for image rendering. */ constructor(resolution: Vintasoft.Shared.WebResolutionJS); /** * Initializes a new instance of the [see= "WebRenderingSettingsJS"] class. */ constructor(); // PROPERTIES /** * Gets a type of rendering settings. */ get_Type(): string; /** * Gets the resolution, in pixels per inch, for image rendering. */ get_Resolution(): Vintasoft.Shared.WebResolutionJS; /** * Sets the resolution, in pixels per inch, for image rendering. * @param value WebResolutionJS object that represents image resolution, in pixels per inch, for image rendering. */ set_Resolution(value: Vintasoft.Shared.WebResolutionJS): void; /** * Gets the interpolation mode for image rendering. */ get_InterpolationMode(): Vintasoft.Shared.WebInterpolationModeEnumJS; /** * Sets the interpolation mode for image rendering. * @param value An instance of [see="WebInterpolationModeEnumJS"] class that represents interpolation mode for image rendering. */ set_InterpolationMode(value: Vintasoft.Shared.WebInterpolationModeEnumJS): void; /** * Gets the smoothing mode for image rendering. */ get_SmoothingMode(): Vintasoft.Shared.WebSmoothingModeEnumJS; /** * Sets the smoothing mode for image rendering. * @param value An instance of [see="WebSmoothingModeEnumJS"] class that represents smoothing mode for image rendering. */ set_SmoothingMode(value: Vintasoft.Shared.WebSmoothingModeEnumJS): void; // METHODS /** * Creates an exact copy of this [see="WebRenderingSettingsJS"]. */ clone(): Vintasoft.Shared.WebRenderingSettingsJS; /** * Determines whether the specified rendering settings is equal to the current rendering settings. * @param value The rendering settings to compare with the current rendering settings. */ equals(value: Vintasoft.Shared.WebRenderingSettingsJS): boolean; /** * Returns a value indicating whether the rendering settings is empty. */ isEmpty(): boolean; /** * Begins the settings initialization. */ beginInit(): void; /** * Ends the settings initialization. */ endInit(): void; /** * Returns settings as object. */ toObject(): object; } /** * Contains settings for rendering of PDF page. */ class WebPdfRenderingSettingsJS extends Vintasoft.Shared.WebRenderingSettingsJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebPdfRenderingSettingsJS"] class. * @param resolution Resolution, in pixels per inch, for image rendering. * @param interpolationMode [see="WebInterpolationModeEnumJS"] for image rendering. * @param smoothingMode [see="WebSmoothingModeEnumJS"] for image rendering. */ constructor(resolution: Vintasoft.Shared.WebResolutionJS, interpolationMode: Vintasoft.Shared.WebInterpolationModeEnumJS, smoothingMode: Vintasoft.Shared.WebSmoothingModeEnumJS); /** * Initializes a new instance of the [see= "WebPdfRenderingSettingsJS"] class. * @param resolution Resolution, in pixels per inch, for image rendering. * @param interpolationMode [see="WebInterpolationModeEnumJS"] for image rendering. */ constructor(resolution: Vintasoft.Shared.WebResolutionJS, interpolationMode: Vintasoft.Shared.WebInterpolationModeEnumJS); /** * Initializes a new instance of the [see= "WebPdfRenderingSettingsJS"] class. * @param resolution Resolution, in pixels per inch, for image rendering. */ constructor(resolution: Vintasoft.Shared.WebResolutionJS); /** * Initializes a new instance of the [see= "WebPdfRenderingSettingsJS"] class. */ constructor(); // PROPERTIES /** * Gets a type of rendering settigns. */ get_Type(): string; /** * Gets a value indicating whether PDF page renderer should display PDF non-markup annotations on PDF page. */ get_DrawNonMarkupAnnotations(): boolean; /** * Sets a value indicating whether PDF page renderer should display PDF non-markup annotations on PDF page. * @param value A value indicating whether PDF page renderer should display PDF non-markup annotations on PDF page. Default value is True. */ set_DrawNonMarkupAnnotations(value: boolean): void; /** * Gets a value indicating whether PDF page renderer should enable text editor on PDF page. */ get_EnableTextEditorMode(): boolean; /** * Sets a value indicating whether PDF page renderer should enable text editor on PDF page. * @param value A value that determines whether PDF page renderer should enable text editor on PDF page. Default value is False. */ set_EnableTextEditorMode(value: boolean): void; // METHODS /** * Creates an exact copy of this object. */ clone(): Vintasoft.Shared.WebPdfRenderingSettingsJS; /** * Determines whether the specified rendering settings is equal to the current rendering settings. * @param temp The rendering settings to compare with the current rendering settings. */ equals(temp: Vintasoft.Shared.WebPdfRenderingSettingsJS): boolean; /** * Returns a value indicating whether the rendering settings is empty. */ isEmpty(): boolean; /** * Returns settings as object. */ toObject(): object; } /** * Provides a base class for rendering settings that contains a group of rendering settings. */ class WebCompositeRenderingSettingsJS extends Vintasoft.Shared.WebRenderingSettingsJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebCompositeRenderingSettingsJS"] class. * @param settings Array of rendering settings of composite rendering settings. */ constructor(settings: Vintasoft.Shared.WebRenderingSettingsJS[]); // PROPERTIES /** * Gets the items of this composite rendering settings. */ get_Settings(): Vintasoft.Shared.WebRenderingSettingsJS[]; /** * Sets the resolution, in pixels per inch, for image rendering. * @param value An WebResolutionJS class that represents image resolution, in pixels per inch, for image rendering. */ set_Resolution(value: Vintasoft.Shared.WebResolutionJS): void; /** * Sets the interpolation mode for image rendering. * @param value An instance of [see="WebInterpolationModeEnumJS"] class that represents interpolation mode for image rendering. */ set_InterpolationMode(value: Vintasoft.Shared.WebInterpolationModeEnumJS): void; /** * Sets the smoothing mode for image rendering. * @param value An instance of [see="WebSmoothingModeEnumJS"] class that represents smoothing mode for image rendering. */ set_SmoothingMode(value: Vintasoft.Shared.WebSmoothingModeEnumJS): void; // METHODS /** * Begins the settings initialization. */ beginInit(): void; /** * Ends the settings initialization. */ endInit(): void; /** * Creates an exact copy of this [see="WebCompositeRenderingSettingsJS"]. */ clone(): Vintasoft.Shared.WebCompositeRenderingSettingsJS; /** * Determines whether the specified rendering settings is equal to the current rendering settings. * @param temp The rendering settings to compare with the current rendering settings. */ equals(temp: Vintasoft.Shared.WebCompositeRenderingSettingsJS): boolean; /** * Returns a value indicating whether the rendering settings is empty. */ isEmpty(): boolean; /** * Returns settings as object. */ toObject(): object; } /** * Contains decoding settings of image. */ class WebDecodingSettingsJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebDecodingSettingsJS"] class. */ constructor(); // PROPERTIES /** * Gets a value indicating whether the color management is enabled. */ get_IsColorManagementEnabled(): boolean; /** * Sets a value indicating whether the color management is enabled. * @param value True - the color management is enabled; False - the color management is disabled. Default value is True. */ set_IsColorManagementEnabled(value: boolean): void; // METHODS /** * Creates an exact copy of this [see="WebDecodingSettingsJS"]. */ clone(): Vintasoft.Shared.WebDecodingSettingsJS; /** * Determines whether the specified decoding settings is equal to the current decoding settings. * @param value The decoding settings to compare with the current decoding settings. */ equals(value: Vintasoft.Shared.WebDecodingSettingsJS): boolean; /** * Returns settings as object. */ toObject(): object; } /** * Provides a page layout settings. */ class WebPageLayoutSettingsJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebPageLayoutSettingsJS"] class. */ constructor(); // PROPERTIES /** * Gets the content scale. */ get_ContentScale(): number; /** * Sets the content scale. * @param value The content scale. Default value is null (content scale is not specified). */ set_ContentScale(value: number): void; /** * Gets width, in millimeters, of a document page. */ get_PageWidth(): number; /** * Sets width, in millimeters, of a document page. * @param value Width, in millimeters, of a document page. Default value is null (width from document is used). */ set_PageWidth(value: number): void; /** * Gets height, in millimeters, of a document page. */ get_PageHeight(): number; /** * Sets height, in millimeters, of a document page. * @param value Height, in millimeters, of a document page. Default value is null (height from document is used). */ set_PageHeight(value: number): void; /** * Gets padding, in millimeters, of a document page. */ get_PagePadding(): number; /** * Sets padding, in millimeters, of a document page. * @param value Padding, in millimeters, of a document page. Default value is null (padding is not specified). */ set_PagePadding(value: number): void; // METHODS /** * Returns settings as object. */ toObject(): object; } /** * Provides layout settings for a document. */ class WebDocumentLayoutSettingsJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebDocumentLayoutSettingsJS"] class. */ constructor(); // PROPERTIES /** * Gets the layout settings for document page. */ get_PageLayoutSettings(): Vintasoft.Shared.WebPageLayoutSettingsJS; /** * Sets the layout settings for document page. * @param value The layout settings for document page. */ set_PageLayoutSettings(value: Vintasoft.Shared.WebPageLayoutSettingsJS): void; /** * Gets a value indicating whether the hidden content must be shown on DOCX page. */ get_DocxShowHiddenContent(): boolean; /** * Sets a value indicating whether the hidden content must be shown on DOCX page. * @param value True - hidden content must be shown on DOCX page; false - hidden content must not be shown on DOCX page. Default value is false. */ set_DocxShowHiddenContent(value: boolean): void; /** * Gets the type of layout settings for XLSX page. */ get_XlsxPageLayoutSettingsType(): Vintasoft.Shared.WebXlsxPageLayoutSettingsTypeEnumJS; /** * Sets the type of layout settings for XLSX page. * @param value The type of layout settings for XLSX page. Default value is "WebXlsxPageLayoutSettingsTypeEnumJS.UsePageMargin | WebXlsxPageLayoutSettingsTypeEnumJS.UsePageScale | WebXlsxPageLayoutSettingsTypeEnumJS.UsePrintArea". */ set_XlsxPageLayoutSettingsType(value: Vintasoft.Shared.WebXlsxPageLayoutSettingsTypeEnumJS): void; /** * Gets a value indicating whether the hidden XLSX worksheets must be shown. */ get_XlsxShowHiddenSheets(): boolean; /** * Sets a value indicating whether the hidden XLSX worksheets must be shown. * @param value True - hidden XLSX worksheets must be shown; false - hidden XLSX worksheets must not be shown. Default value is false. */ set_XlsxShowHiddenSheets(value: boolean): void; /** * Gets a value indicating whether the hidden graphics must be shown on XLSX page. */ get_XlsxShowHiddenGraphics(): boolean; /** * Sets a value indicating whether the hidden graphics must be shown on XLSX page. * @param value True - hidden graphics must be shown on XLSX page; false - hidden graphics must not be shown on XLSX page. Default value is false. */ set_XlsxShowHiddenGraphics(value: boolean): void; // METHODS /** * Returns settings as object. */ toObject(): object; } /** * Contains information about file with password and custom layout settings. */ class WebFileInfoJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebFileInfoJS"] class. * @param id A string, which represents a file identifier. * @param password A string, which represents a file password. * @param documentLayoutSettings A document layout settings. */ constructor(id: string, password: string, documentLayoutSettings: Vintasoft.Shared.WebDocumentLayoutSettingsJS); /** * Initializes a new instance of the [see= "WebFileInfoJS"] class. * @param id A string, which represents a file identifier. * @param password A string, which represents a file password. */ constructor(id: string, password: string); /** * Initializes a new instance of the [see= "WebFileInfoJS"] class. * @param id A string, which represents a file identifier. */ constructor(id: string); // PROPERTIES /** * Gets a file identifier. */ get_Id(): string; /** * Gets a file password. */ get_Password(): string; /** * Gets a document layout settings. */ get_DocumentLayoutSettings(): Vintasoft.Shared.WebDocumentLayoutSettingsJS; } /** * Represents a source of web image. */ class WebImageSourceJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebImageSourceJS"] class. * @param imageId A string, which represents a file identifier. * @param imageService A [see="WebServiceJS"], which allows to work with image. * @param annotationService A [see="WebServiceJS"], which allows to annotate image. */ constructor(imageId: string, imageService: Vintasoft.Shared.WebServiceJS, annotationService: Vintasoft.Shared.WebServiceJS); /** * Initializes a new instance of the [see= "WebImageSourceJS"] class. * @param imageId A string, which represents a file identifier. * @param imageService A [see="WebServiceJS"], which allows to work with image. */ constructor(imageId: string, imageService: Vintasoft.Shared.WebServiceJS); /** * Initializes a new instance of the [see= "WebImageSourceJS"] class. * @param imageId A string, which represents a file identifier. */ constructor(imageId: string); // PROPERTIES /** * Gets an identifier that determines the image source. */ get_ImageId(): string; /** * Gets the web service that allows to work with web image. */ get_ImageService(): Vintasoft.Shared.WebServiceJS; /** * Gets the web service that allows to work with annotations of web image. */ get_AnnotationService(): Vintasoft.Shared.WebServiceJS; /** * Gets the image source password. */ get_Password(): string; /** * Sets the image source password. * @param value The image source password. */ set_Password(value: string): void; // METHODS /** * Determines whether the specified image source is equal to the current image source. * @param imageSource The image source to compare with the current image source. */ equals(imageSource: Vintasoft.Shared.WebImageSourceJS): boolean; } /** * Represents a web image. */ class WebImageJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebImageJS"] class. * @param imageSource [see="WebImageSourceJS"] object. * @param pageIndex Zero-based index of image in image source. */ constructor(imageSource: Vintasoft.Shared.WebImageSourceJS, pageIndex: number); // PROPERTIES /** * Gets an identifier that determines the image source. */ get_ImageId(): string; /** * Gets the image size. */ get_Size(): object; /** * Gets the image resolution. */ get_Resolution(): object; /** * Gets the image pixel format. */ get_PixelFormat(): Vintasoft.Shared.WebPixelFormatEnumJS; /** * Gets the [see="WebImageSourceJS"] object of current image. */ get_Source(): Vintasoft.Shared.WebImageSourceJS; /** * Gets the zero-based index of image in image source. */ get_PageIndex(): number; /** * Gets a value indicating whether the image has a vector decoder and image is not changed. */ get_IsVector(): boolean; /** * Gets a value indicating whether the image can be converted to SVG optimally. */ get_CanConvertToSvgOptimally(): boolean; /** * Gets the rendering settings for this image. */ get_RenderingSettings(): Vintasoft.Shared.WebRenderingSettingsJS; /** * Sets the rendering settings for this image. * @param value [see="WebRenderingSettingsJS"] for this image. */ set_RenderingSettings(value: Vintasoft.Shared.WebRenderingSettingsJS): void; /** * Gets the decoding settings of this image. */ get_DecodingSettings(): Vintasoft.Shared.WebDecodingSettingsJS; /** * Sets the decoding settings of this image. * @param value [see="WebDecodingSettingsJS"] of this image. */ set_DecodingSettings(value: Vintasoft.Shared.WebDecodingSettingsJS): void; /** * Gets the unique guid associated with this [see="WebImageJS"] object. */ get_Guid(): string; /** * Gets a value indicating whether the image is bad, i.e. information about image cannot be loaded OR image cannot be rendered. */ get_IsBad(): boolean; /** * Gets the Vintasoft.Imaging.WebImageMetadataJS object, which contains metadata associated with the source image. */ get_Metadata(): object; /** * Gets the decoder name. */ get_DecoderName(): string; // METHODS /** * Determines whether the specified image is equal to the current image. * @param image The image to compare with the current image. */ equals(image: Vintasoft.Shared.WebImageJS): boolean; /** * Sends an asynchronous request for rendering of image tile. * @param tileRenderingSettings Settings for rendering of image tile.
An object with following properties:
* @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ renderTile(tileRenderingSettings: object, successFunc: Function, errorFunc: Function): object; /** * Sends an asynchronous request for rendering of the "main" image tile and all neighbour image tiles around the main image tile. * @param tileRenderingSettings Settings for rendering of image tile.
An object with following properties:
* @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ renderTileWithNeighbours(tileRenderingSettings: object, successFunc: Function, errorFunc: Function): object; /** * Sends an asynchronous request for rendering of all image tiles. * @param tilesRenderingSettings Settings for rendering of image tiles.
An object with following properties:
* @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)". * @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ renderTiles(tilesRenderingSettings: object, successFunc: Function, errorFunc: Function): object; /** * Sends an asynchronous request for rendering of image thumbnail. * @param thumbnailRenderingSettings Settings for rendering of image thumbnail.
An object with following properties:
* @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ renderThumbnail(thumbnailRenderingSettings: object, successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request for getting information about image. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ getImageInfo(successFunc: Function, errorFunc: Function): object; /** * Sends an asynchronous request for getting of image. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ getImageAsBase64String(successFunc: Function, errorFunc: Function): object; /** * Clones this image. */ clone(): Vintasoft.Shared.WebImageJS; /** * Returns the string representation of this object. */ toString(): string; } /** * Represents a collection of web images (collection of instances of [see="WebImageJS"] class). */ class WebImageCollectionJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebImageCollectionJS"] class. */ constructor(); // PROPERTIES /** * Gets the number of images contained in the collection. */ get_Count(): number; // METHODS /** * Returns an image. * @param index Zero-based index of image in image collection. */ getImage(index: number): Vintasoft.Shared.WebImageJS; /** * Gets the index of the specified [see="WebImageJS"] object. * @param image The [see="WebImageJS"] object to search for. */ indexOf(image: Vintasoft.Shared.WebImageJS): number; /** * Clears the collection. */ clear(): void; /** * Adds an image to the end of the collection. * @param image [see="WebImageJS"] to add. */ add(image: Vintasoft.Shared.WebImageJS): void; /** * Adds images to the end of the collection. * @param images An array of [see="WebImageJS"] objects. */ addRange(images: Vintasoft.Shared.WebImageJS[]): void; /** * Adds images to the end of the collection. * @param images An image collection, which is represented by [see="WebImageCollectionJS"] object. */ addRange(images: Vintasoft.Shared.WebImageCollectionJS): void; /** * Inserts an image into collection at the specified index. * @param index The zero-based index at which image should be inserted. * @param image [see="WebImageJS"] to insert. */ insert(index: number, image: Vintasoft.Shared.WebImageJS): void; /** * Inserts images into collection at the specified index. * @param index The zero-based index at which image should be inserted. * @param images An array of [see="WebImageJS"] objects. */ insertRange(index: number, images: Vintasoft.Shared.WebImageJS[]): void; /** * Inserts images into collection at the specified index. * @param index The zero-based index at which image should be inserted. * @param images An image collection, which is represented by [see="WebImageCollectionJS"] object. */ insertRange(index: number, images: Vintasoft.Shared.WebImageCollectionJS): void; /** * Swaps the specified images in the collection. * @param firstIndex The index of first image that should be swapped. * @param secondIndex The index of second image that should be swapped. */ swap(firstIndex: number, secondIndex: number): void; /** * Removes images at specified indexes and inserts them at specified index. * @param insertIndex The zero-based index at which the images should be inserted. * @param indexes An array that contains indexes of images that must be moved. */ moveRange(insertIndex: number, indexes: number[]): number; /** * Removes specified image from the collection. * @param index The zero-based index of image which should be removed. */ removeAt(index: number): void; /** * Removes specified image from the collection. * @param image [see="WebImageJS"] to remove. */ remove(image: Vintasoft.Shared.WebImageJS): void; /** * Removes the specified images from the collection. * @param images An array of [see="WebImageJS"] objects, which must be removed. */ removeImages(images: Vintasoft.Shared.WebImageJS[]): void; /** * Removes the specified images from the collection. * @param imageIndices imageIndices Zero-based indices of images, which must be removed. */ removeRange(imageIndices: number[]): void; /** * Sets information about the specified image. * @param index The zero-based index of image, which should be changed. * @param image New [see="WebImageJS"] at the specified index. * @param commandName The name of the image processing command that sets this image. */ set(index: number, image: Vintasoft.Shared.WebImageJS, commandName: string): void; /** * Returns the collection as array of [see="WebImageJS"] objects. */ toArray(): Vintasoft.Shared.WebImageJS[]; /** * Sets the rendering settings for all images from this collection. * @param value [see="WebRenderingSettingsJS"] for all images from this collection. */ setRenderingSettings(value: Vintasoft.Shared.WebRenderingSettingsJS): void; /** * Sets the decoding settings for all images from this collection. * @param value [see="WebDecodingSettingsJS"] for all images from this collection. */ setDecodingSettings(value: Vintasoft.Shared.WebDecodingSettingsJS): void; /** * Sets the default decoding settings for all images from this collection. */ setDecodingSettings(): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"], which allows to manage an image collection. */ getImageFilesInfos(fileIds: string[], successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ getImageFilesInfos(fileIds: string[], successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ getImageFilesInfos(fileIds: string[], successFunc: Function): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. * @param fileIds An array of strings, which represent file identifiers. * @param service [see="WebServiceJS"] which allows to manage an image collection. */ getImageFilesInfos(fileIds: string[], service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"] which allows to manage an image collection. */ getImageFilesInfos(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ getImageFilesInfos(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ getImageFilesInfos(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function): void; /** * Sends an asynchronous request to a server and gets information about images, which are stored in files on server. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param service [see="WebServiceJS"] which allows to manage an image collection. */ getImageFilesInfos(fileIds: Vintasoft.Shared.WebFileInfoJS[], service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. * @param fileId A string, which represents a file identifier. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"] which allows to manage an image collection. */ openFile(fileId: string, successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId A string, which represents a file identifier. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ openFile(fileId: string, successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId A string, which represents a file identifier. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ openFile(fileId: string, successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId A string, which represents a file identifier. */ openFile(fileId: string): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. * @param fileId An instance of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"] which allows to manage an image collection. */ openFile(fileId: Vintasoft.Shared.WebFileInfoJS, successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId An instance of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ openFile(fileId: Vintasoft.Shared.WebFileInfoJS, successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId An instance of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ openFile(fileId: Vintasoft.Shared.WebFileInfoJS, successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, clears the image collection and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId An instance of [see="WebFileInfoJS"] class. */ openFile(fileId: Vintasoft.Shared.WebFileInfoJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. * @param fileId A string, which represents a file identifier. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"] which allows to manage an image collection. */ addFile(fileId: string, successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId A string, which represents a file identifier. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ addFile(fileId: string, successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId A string, which represents a file identifier. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ addFile(fileId: string, successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId A string, which represents a file identifier. */ addFile(fileId: string): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. * @param fileId An instance of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"] which allows to manage an image collection. */ addFile(fileId: Vintasoft.Shared.WebFileInfoJS, successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId An instance of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ addFile(fileId: Vintasoft.Shared.WebFileInfoJS, successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId An instance of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ addFile(fileId: Vintasoft.Shared.WebFileInfoJS, successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. This function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileId An instance of [see="WebFileInfoJS"] class. */ addFile(fileId: Vintasoft.Shared.WebFileInfoJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"], which allows to manage an image collection. */ openFiles(fileIds: string[], successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ openFiles(fileIds: string[], successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ openFiles(fileIds: string[], successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. * @param fileIds An array of strings, which represent file identifiers. * @param service [see="WebServiceJS"], which allows to manage an image collection. */ openFiles(fileIds: string[], service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"], which allows to manage an image collection. */ openFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ openFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ openFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and clears the image collection and adds images to the image collection. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param service [see="WebServiceJS"], which allows to manage an image collection. */ openFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"], which allows to manage image collection. */ addFiles(fileIds: string[], successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ addFiles(fileIds: string[], successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of strings, which represent file identifiers. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ addFiles(fileIds: string[], successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. * @param fileIds An array of strings, which represent file identifiers. * @param service [see="WebServiceJS"], which allows to manage an image collection. */ addFiles(fileIds: string[], service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
* @param service [see="WebServiceJS"], which allows to manage an image collection. */ addFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function, errorFunc: Function, service: Vintasoft.Shared.WebServiceJS): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
* @param errorFunc Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
*/ addFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function, errorFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. Function uses web service specified by WebServiceJS.defaultImageCollectionService property. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param successFunc Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
*/ addFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], successFunc: Function): void; /** * Sends an asynchronous request to a server, gets information about images, which are stored in files on server, and adds images to the image collection. * @param fileIds An array of instances of [see="WebFileInfoJS"] class. * @param service [see="WebServiceJS"], which allows to manage an image collection. */ addFiles(fileIds: Vintasoft.Shared.WebFileInfoJS[], service: Vintasoft.Shared.WebServiceJS): void; } /** * Provides methods for placing data on and retrieving data from local clipboard. */ class WebObjectClipboardJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebObjectClipboardJS"] class. */ constructor(); // METHODS /** * Clears the Clipboard and adds data in the specified format to the Clipboard. * @param format The format of the data to set. * @param data Data to add. */ setData(format: string, data: object): void; /** * Retrieves data, in the specified format, from the Clipboard. * @param format The format of the data to retrieve. */ getData(format: string): object; /** * Removes all data from the Clipboard. */ clear(): void; /** * Indicates whether the Clipboard contains data in the specified format. * @param format The format of the data to look for. */ contains(format: string): boolean; } /** * Provides functionality for localization DOM elements and constant strings. */ class VintasoftLocalizationJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "VintasoftLocalizationJS"] class. */ constructor(); // PROPERTIES /** * Gets a value indicating whether the localizer is ready for localization. */ get_IsReady(): boolean; // METHODS /** * Returns localization info for the specified localization identifier. * @param id The localization identifier. */ getLocalizationInfo(id: string): object; /** * Localizes all DOM-elements, which have the "localizationId" attribute, in HTML document. */ localizeDocument(): void; /** * Returns the localization dictionary for all DOM-elements, which have the "localizationId" attribute, in HTML document. */ getDocumentLocalizationDictionary(): void; /** * Sets the string constant for localization. * @param id The identifier of string constant. * @param value The string constant that should be localized. */ static setStringConstant(id: string, value: string): void; /** * Gets the string constant by identifier. * @param id The identifier of string constant. */ static getStringConstant(id: string): string; } /** * Stores an ordered pair of float values, typically the horizontal and vertical resolution. */ class WebResolutionJS { // CONTSRUCTORS /** * Initializes a new instance of the [see= "WebResolutionJS"] class. * @param x Horizontal resolution, in pixels per inch. * @param y Vertical resolution, in pixels per inch. */ constructor(x: number, y: number); // PROPERTIES /** * Gets the horizontal resolution, in pixels per inch. */ get_Horizontal(): number; /** * Gets the vertical resolution, in pixels per inch. */ get_Vertical(): number; // METHODS /** * Determines whether the specified object is equal to the current object. * @param obj The object to compare with the current object. */ equals(obj: Vintasoft.Shared.WebResolutionJS): boolean; /** * Gets a value indicating whether this margin is empty. */ isEmpty(): boolean; /** * Serves as a hash function for a particular type. */ getHashCode(): number; /** * Return copy of item. */ createCopy(): Vintasoft.Shared.WebResolutionJS; /** * Returns the empty resolution. */ static get_Empty(): Vintasoft.Shared.WebResolutionJS; } }