fit-ui 2.9.2 → 2.10.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/types/index.d.ts CHANGED
@@ -1411,6 +1411,12 @@ declare namespace Fit
1411
1411
  {
1412
1412
  // Functions defined by Fit.Controls.Component
1413
1413
  /**
1414
+ * Component constructor.
1415
+ * @function Component
1416
+ * @param {string} [ctlId=undefined] - Unique component ID that can be used to access component using Fit.Controls.Find(..).
1417
+ */
1418
+ constructor(ctlId?:string);
1419
+ /**
1414
1420
  * Destroys control to free up memory.
1415
1421
  Make sure to call Dispose() on Component which can be done like so:
1416
1422
  this.Dispose = Fit.Core.CreateOverride(this.Dispose, function()
@@ -1743,6 +1749,12 @@ declare namespace Fit
1743
1749
  */
1744
1750
  public Clear():void;
1745
1751
  /**
1752
+ * ControlBase constructor.
1753
+ * @function ControlBase
1754
+ * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
1755
+ */
1756
+ constructor(ctlId?:string);
1757
+ /**
1746
1758
  * Get/set value indicating whether control is enabled or disabled.
1747
1759
  A disabled control's value and state is still included on postback, if part of a form.
1748
1760
  * @function Enabled
@@ -2565,6 +2577,11 @@ declare namespace Fit
2565
2577
  */
2566
2578
  public RemoveButton(btn:Fit.Controls.Button, dispose?:boolean):void;
2567
2579
  /**
2580
+ * Reset custom size (Resizable enabled) and position (Draggable enabled).
2581
+ * @function Reset
2582
+ */
2583
+ public Reset():void;
2584
+ /**
2568
2585
  * Get/set flag indicating whether dialog can be resized by the user.
2569
2586
  * @function Resizable
2570
2587
  * @param {boolean} [val=undefined] - If defined, a value of True enables resizing, False disables it (default).
@@ -2618,882 +2635,661 @@ declare namespace Fit
2618
2635
  public Render(toElement?:HTMLElement):void;
2619
2636
  }
2620
2637
  /**
2621
- * Simple interface for controlling Prompt, Confirm, and Alert dialogs.
2622
- * @class [Fit.Controls.DialogInterface DialogInterface]
2638
+ * Dialog containing HTML editor for rich text editing.
2639
+ * @class [Fit.Controls.DialogEditor DialogEditor]
2623
2640
  */
2624
- class DialogInterface
2641
+ class DialogEditor
2625
2642
  {
2626
- // Functions defined by Fit.Controls.DialogInterface
2643
+ // Functions defined by Fit.Controls.DialogEditor
2627
2644
  /**
2628
- * Cancel dialog - equivalent to clicking the Cancel button, or the OK button on an Alert dialog.
2629
- * @function Cancel
2645
+ * Get/set value indicating whether control should have spell checking enabled (default) or disabled.
2646
+ * @function CheckSpelling
2647
+ * @param {boolean} [val=undefined] - If defined, true enables spell checking while false disables it.
2648
+ * @returns boolean
2630
2649
  */
2631
- public Cancel():void;
2650
+ public CheckSpelling(val?:boolean):boolean;
2632
2651
  /**
2633
- * Confirm dialog - equivalent to clicking the OK button.
2634
- * @function Confirm
2652
+ * Create instance of DialogEditor control.
2653
+ * @function DialogEditor
2654
+ * @param {string} [controlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
2635
2655
  */
2636
- public Confirm():void;
2656
+ constructor(controlId?:string);
2637
2657
  /**
2638
- * Dismiss dialog without taking any action.
2639
- * @function Dismiss
2658
+ * Get/set value indicating whether control is enabled or disabled.
2659
+ * @function Enabled
2660
+ * @param {boolean} [val=undefined] - If defined, True enables control (default), False disables control.
2661
+ * @returns boolean
2640
2662
  */
2641
- public Dismiss():void;
2642
- }
2643
- /**
2644
- *
2645
- * @namespace [Fit.Controls.DialogTypeDefs DialogTypeDefs]
2646
- */
2647
- namespace DialogTypeDefs
2648
- {
2649
- // Functions defined by Fit.Controls.DialogTypeDefs
2663
+ public Enabled(val?:boolean):boolean;
2650
2664
  /**
2651
- * Confirmation dialog callback.
2652
- * @callback ConfirmCallback
2653
- * @param {boolean} confirmed - True if OK button is clicked, otherwise False.
2665
+ * Get/set value indicating whether editor control has focus.
2666
+ Dialog must be open and visible for focus assignment to work.
2667
+ * @function Focused
2668
+ * @param {boolean} [value=undefined] - If defined, True assigns focus, False removes focus (blur).
2669
+ * @returns boolean
2654
2670
  */
2655
- type ConfirmCallback = (confirmed:boolean) => void;
2671
+ public Focused(value?:boolean):boolean;
2656
2672
  /**
2657
- * Dialog event handler.
2658
- * @callback DialogEventHandler
2659
- * @param {Fit.Controls.Dialog} sender - Instance of Dialog.
2673
+ * Get value indicating whether user has changed control value.
2674
+ * @function IsDirty
2675
+ * @returns boolean
2660
2676
  */
2661
- type DialogEventHandler = (sender:Fit.Controls.Dialog) => void;
2677
+ public IsDirty():boolean;
2662
2678
  /**
2663
- * Prompt dialog callback.
2664
- * @callback PromptCallback
2665
- * @param {string | null} value - String value entered if OK button is clicked, Null if prompt is canceled.
2679
+ * Get/set value used as a placeholder to indicate expected input on supported browsers.
2680
+ * @function Placeholder
2681
+ * @param {string} [val=undefined] - If defined, value is set as placeholder.
2682
+ * @returns string
2666
2683
  */
2667
- type PromptCallback = (value:string | null) => void;
2668
- }
2669
- /**
2670
- * Drop Down Menu control allowing for single and multi selection.
2671
- Supports data selection using any control extending from Fit.Controls.PickerBase.
2672
- This control is extending from Fit.Controls.ControlBase.
2673
- * @class [Fit.Controls.DropDown DropDown]
2674
- */
2675
- class DropDown
2676
- {
2677
- // Functions defined by Fit.Controls.DropDown
2684
+ public Placeholder(val?:string):string;
2678
2685
  /**
2679
- * Add selection to control.
2680
- * @function AddSelection
2681
- * @param {string} title - Item title.
2682
- * @param {string} value - Item value.
2683
- * @param {boolean} [valid=true] - Flag indicating whether selection is valid or not. Invalid selections are highlighted and
2684
- not included when selections are retrived using Value() function, and not considered when
2685
- IsDirty() is called to determine whether control value has been changed by user.
2686
- GetSelections(true) can be used to retrive all items, including invalid selections.
2686
+ * Get/set editor control value.
2687
+ * @function Value
2688
+ * @param {string} [val=undefined] - If defined, value is inserted into control.
2689
+ * @returns string
2687
2690
  */
2688
- public AddSelection(title:string, value:string, valid?:boolean):void;
2691
+ public Value(val?:string):string;
2692
+ // Functions defined by Fit.Controls.Dialog
2689
2693
  /**
2690
- * Clear text field.
2691
- * @function ClearInput
2694
+ * Display alert dialog.
2695
+ * @function Alert
2696
+ * @static
2697
+ * @param {string} content - Content to display in alert dialog.
2698
+ * @param {Function} [cb=undefined] - Optional callback function invoked when OK button is clicked.
2699
+ * @returns Fit.Controls.DialogInterface
2692
2700
  */
2693
- public ClearInput():void;
2701
+ public static Alert(content:string, cb?:Function):Fit.Controls.DialogInterface;
2694
2702
  /**
2695
- * Clear selections.
2696
- * @function ClearSelections
2703
+ * Display confirmation dialog with OK and Cancel buttons.
2704
+ * @function Confirm
2705
+ * @static
2706
+ * @param {string} content - Content to display in confirmation dialog.
2707
+ * @param {Fit.Controls.DialogTypeDefs.ConfirmCallback} cb - Callback function invoked when a button is clicked.
2708
+ True is passed to callback function when OK is clicked, otherwise False.
2709
+ * @returns Fit.Controls.DialogInterface
2697
2710
  */
2698
- public ClearSelections():void;
2711
+ public static Confirm(content:string, cb:Fit.Controls.DialogTypeDefs.ConfirmCallback):Fit.Controls.DialogInterface;
2699
2712
  /**
2700
- * Close drop down menu.
2701
- * @function CloseDropDown
2713
+ * Display prompt dialog that allows for user input.
2714
+ * @function Prompt
2715
+ * @static
2716
+ * @param {string} content - Content to display in prompt dialog.
2717
+ * @param {string} defaultValue - Default value in input field.
2718
+ * @param {Fit.Controls.DialogTypeDefs.PromptCallback} [cb=undefined] - Callback function invoked when OK or Cancel button is clicked.
2719
+ Value entered in input field is passed, null if prompt is canceled.
2720
+ * @returns Fit.Controls.DialogInterface
2702
2721
  */
2703
- public CloseDropDown():void;
2722
+ public static Prompt(content:string, defaultValue:string, cb?:Fit.Controls.DialogTypeDefs.PromptCallback):Fit.Controls.DialogInterface;
2704
2723
  /**
2705
- * Get/set value indicating whether boundary/collision detection is enabled or not (off by default).
2706
- This may cause drop down to open upwards if sufficient space is not available below control.
2707
- If control is contained in a scrollable parent, this will be considered the active viewport,
2708
- and as such define the active boundaries - unless relativeToViewport is set to True, in which
2709
- case the actual browser viewport will be used.
2710
- * @function DetectBoundaries
2711
- * @param {boolean} [val=undefined] - If defined, True enables collision detection, False disables it (default).
2712
- * @param {boolean} [relativeToViewport=false] - If defined, True results in viewport being considered the container to which available space is determined.
2713
- This also results in DropDown menu being positioned with position:fixed, allowing it to escape a container
2714
- with overflow (e.g. overflow:auto|hidden|scroll). Be aware though that this does not work reliably in combination
2715
- with CSS animation and CSS transform as it creates a new stacking context to which position:fixed becomes relative.
2716
- A value of False (default) results in available space being determined relative to the boundaries of the
2717
- control's scroll parent. The DropDown menu will stay within its container and not overflow it.
2718
- * @returns boolean
2724
+ * Add button to dialog.
2725
+ * @function AddButton
2726
+ * @param {Fit.Controls.Button} btn - Instance of Fit.Controls.Button.
2719
2727
  */
2720
- public DetectBoundaries(val?:boolean, relativeToViewport?:boolean):boolean;
2728
+ public AddButton(btn:Fit.Controls.Button):void;
2721
2729
  /**
2722
- * Create instance of DropDown control.
2723
- * @function DropDown
2724
- * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
2730
+ * Bring draggable dialog to front.
2731
+ * @function BringToFront
2725
2732
  */
2726
- constructor(ctlId?:string);
2733
+ public BringToFront():void;
2727
2734
  /**
2728
- * Get/set max height of drop down - returns object with Value (number) and Unit (string) properties.
2729
- * @function DropDownMaxHeight
2730
- * @param {number} [value=undefined] - If defined, max height is updated to specified value. A value of -1 forces picker to fit height to content.
2731
- * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=undefined] - If defined, max height is updated to specified CSS unit, otherwise px is assumed.
2732
- * @returns Fit.TypeDefs.CssValue
2735
+ * Close dialog.
2736
+ * @function Close
2733
2737
  */
2734
- public DropDownMaxHeight(value?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2738
+ public Close():void;
2735
2739
  /**
2736
- * Get/set max width of drop down - returns object with Value (number) and Unit (string) properties.
2737
- * @function DropDownMaxWidth
2738
- * @param {number} [value=undefined] - If defined, max width is updated to specified value. A value of -1 forces drop down to use control width.
2739
- * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=undefined] - If defined, max width is updated to specified CSS unit, otherwise px is assumed.
2740
- * @returns Fit.TypeDefs.CssValue
2740
+ * Get/set dialog content.
2741
+ * @function Content
2742
+ * @param {string} [val=undefined] - If specified, dialog content is updated with specified value.
2743
+ * @returns string
2741
2744
  */
2742
- public DropDownMaxWidth(value?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2745
+ public Content(val?:string):string;
2743
2746
  /**
2744
- * Get item currently highlighted in picker control.
2745
- Returns an object with Title (string), Value (string),
2746
- and Valid (boolean) properties if found, otherwise Null.
2747
- * @function GetHighlighted
2748
- * @returns Fit.Controls.DropDownTypeDefs.DropDownItem | null
2747
+ * Get/set content URL - returns null if not set.
2748
+ * @function ContentUrl
2749
+ * @param {string} [url=undefined] - If specified, dialog is updated with content from specified URL.
2750
+ * @param {Fit.Controls.DialogTypeDefs.DialogEventHandler} [onLoadHandler=undefined] - If specified, callback is invoked when content has been loaded.
2751
+ Instance of Dialog is passed as an argument.
2752
+ * @returns string | null
2749
2753
  */
2750
- public GetHighlighted():Fit.Controls.DropDownTypeDefs.DropDownItem | null;
2754
+ public ContentUrl(url?:string, onLoadHandler?:Fit.Controls.DialogTypeDefs.DialogEventHandler):string | null;
2751
2755
  /**
2752
- * Get input value.
2753
- * @function GetInputValue
2754
- * @returns string
2756
+ * Get/set flag indicating whether dialog is dismissible or not.
2757
+ * @function Dismissible
2758
+ * @param {boolean} [val=undefined] - If defined, a value of True makes dialog dismissible by adding a close button while False disables it.
2759
+ * @param {boolean} [disposeOnDismiss=undefined] - If defined, a value of True results in dialog being disposed (destroyed) when closed using dismiss/close button.
2760
+ * @returns boolean
2755
2761
  */
2756
- public GetInputValue():string;
2762
+ public Dismissible(val?:boolean, disposeOnDismiss?:boolean):boolean;
2757
2763
  /**
2758
- * Get picker control used to add items to drop down control.
2759
- * @function GetPicker
2760
- * @returns Fit.Controls.PickerBase
2764
+ * Get/set flag indicating whether dialog can be moved around on screen.
2765
+ * @function Draggable
2766
+ * @param {boolean} [val=undefined] - If defined, a value of True enables dragging, False disables it (default).
2767
+ * @returns boolean
2761
2768
  */
2762
- public GetPicker():Fit.Controls.PickerBase;
2769
+ public Draggable(val?:boolean):boolean;
2763
2770
  /**
2764
- * Get selected item by value - returns object with Title (string), Value (string), and Valid (boolean) properties if found, otherwise Null is returned.
2765
- * @function GetSelectionByValue
2766
- * @param {string} val - Value of selected item to retrive.
2767
- * @returns Fit.Controls.DropDownTypeDefs.DropDownItem | null
2771
+ * Get dialog content element.
2772
+ * @function GetContentDomElement
2773
+ * @returns HTMLElement
2768
2774
  */
2769
- public GetSelectionByValue(val:string):Fit.Controls.DropDownTypeDefs.DropDownItem | null;
2775
+ public GetContentDomElement():HTMLElement;
2770
2776
  /**
2771
- * Get selected items - returned array contain objects with Title (string), Value (string), and Valid (boolean) properties.
2772
- * @function GetSelections
2773
- * @param {boolean} [includeInvalid=false] - Flag indicating whether invalid selection should be included or not.
2774
- * @returns Fit.Controls.DropDownTypeDefs.DropDownItem[]
2777
+ * Get/set dialog height - returns object with Value and Unit properties.
2778
+ * @function Height
2779
+ * @param {number} [val=undefined] - If defined, dialog height is updated to specified value. A value of -1 resets height to default.
2780
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, dialog width is updated to specified CSS unit.
2781
+ * @returns Fit.TypeDefs.CssValue
2775
2782
  */
2776
- public GetSelections(includeInvalid?:boolean):Fit.Controls.DropDownTypeDefs.DropDownItem[];
2783
+ public Height(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2777
2784
  /**
2778
- * Make DropDown highlight first selectable item when opened.
2779
- * @function HighlightFirst
2780
- * @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
2785
+ * Get flag indicating whether dialog is open or not.
2786
+ * @function IsOpen
2781
2787
  * @returns boolean
2782
2788
  */
2783
- public HighlightFirst(val?:boolean):boolean;
2789
+ public IsOpen():boolean;
2784
2790
  /**
2785
- * Get/set value indicating whether input is enabled.
2786
- * @function InputEnabled
2787
- * @param {boolean} [val=undefined] - If defined, True enables input, False disables it.
2791
+ * Get/set flag indicating whether dialog is maximizable or not.
2792
+ * @function Maximizable
2793
+ * @param {boolean} [val=undefined] - If defined, a value of True makes dialog maximizable by adding a maximize button while False disables it.
2788
2794
  * @returns boolean
2789
2795
  */
2790
- public InputEnabled(val?:boolean):boolean;
2791
- /**
2792
- * Get/set mouse over text shown for invalid selections.
2793
- * @function InvalidSelectionMessage
2794
- * @param {string} [msg=undefined] - If defined, error message for invalid selections are set.
2795
- * @returns string
2796
- */
2797
- public InvalidSelectionMessage(msg?:string):string;
2796
+ public Maximizable(val?:boolean):boolean;
2798
2797
  /**
2799
- * Get flag indicating whether drop down is open or not.
2800
- * @function IsDropDownOpen
2798
+ * Get/set flag indicating whether dialog is maximized or not.
2799
+ * @function Maximized
2800
+ * @param {boolean} [val=undefined] - If defined, True maximizes dialog while False restores it.
2801
2801
  * @returns boolean
2802
2802
  */
2803
- public IsDropDownOpen():boolean;
2803
+ public Maximized(val?:boolean):boolean;
2804
2804
  /**
2805
- * Get/set flag indicating whether control allows for multiple selections.
2806
- * @function MultiSelectionMode
2807
- * @param {boolean} [val=undefined] - If defined, True enables multi selection mode, False disables it.
2808
- * @returns boolean
2805
+ * Get/set dialog maximum height - returns object with Value and Unit properties.
2806
+ * @function MaximumHeight
2807
+ * @param {number} [val=undefined] - If defined, dialog maximum height is updated to specified value. A value of -1 resets maximum height.
2808
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, dialog maximum height is updated to specified CSS unit.
2809
+ * @returns Fit.TypeDefs.CssValue
2809
2810
  */
2810
- public MultiSelectionMode(val?:boolean):boolean;
2811
+ public MaximumHeight(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2811
2812
  /**
2812
- * Add event handler fired when drop down menu is closed.
2813
- Function receives one argument: Sender (Fit.Controls.DropDown).
2814
- * @function OnClose
2815
- * @param {Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>} cb - Event handler function.
2813
+ * Get/set dialog maximum width - returns object with Value and Unit properties.
2814
+ * @function MaximumWidth
2815
+ * @param {number} [val=undefined] - If defined, dialog maximum width is updated to specified value. A value of -1 resets maximum width.
2816
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, dialog maximum width is updated to specified CSS unit.
2817
+ * @returns Fit.TypeDefs.CssValue
2816
2818
  */
2817
- public OnClose(cb:Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>):void;
2819
+ public MaximumWidth(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2818
2820
  /**
2819
- * Add event handler fired when input value is changed.
2820
- Function receives two arguments:
2821
- Sender (Fit.Controls.DropDown) and Value (string).
2822
- * @function OnInputChanged
2823
- * @param {Fit.Controls.DropDownTypeDefs.InputChangedEventHandler<this>} cb - Event handler function.
2821
+ * Get/set dialog minimum height - returns object with Value and Unit properties.
2822
+ * @function MinimumHeight
2823
+ * @param {number} [val=undefined] - If defined, dialog minimum height is updated to specified value. A value of -1 resets minimum height.
2824
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, dialog minimum height is updated to specified CSS unit.
2825
+ * @returns Fit.TypeDefs.CssValue
2824
2826
  */
2825
- public OnInputChanged(cb:Fit.Controls.DropDownTypeDefs.InputChangedEventHandler<this>):void;
2827
+ public MinimumHeight(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2826
2828
  /**
2827
- * Add event handler fired when drop down menu is opened.
2828
- Function receives one argument: Sender (Fit.Controls.DropDown).
2829
- * @function OnOpen
2830
- * @param {Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>} cb - Event handler function.
2829
+ * Get/set dialog minimum width - returns object with Value and Unit properties.
2830
+ * @function MinimumWidth
2831
+ * @param {number} [val=undefined] - If defined, dialog minimum width is updated to specified value. A value of -1 resets minimum width.
2832
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, dialog minimum width is updated to specified CSS unit.
2833
+ * @returns Fit.TypeDefs.CssValue
2831
2834
  */
2832
- public OnOpen(cb:Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>):void;
2835
+ public MinimumWidth(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2833
2836
  /**
2834
- * Add event handler fired when text is pasted into input field.
2835
- Function receives two arguments:
2836
- Sender (Fit.Controls.DropDown) and Value (string).
2837
- Return False to cancel event and change, and prevent OnInputChanged from firing.
2838
- * @function OnPaste
2839
- * @param {Fit.Controls.DropDownTypeDefs.PasteEventHandler<this>} cb - Event handler function.
2837
+ * Get/set value indicating whether dialog is modal or not.
2838
+ * @function Modal
2839
+ * @param {boolean} [val=undefined] - If specified, True enables modal mode, False disables it.
2840
+ * @returns boolean
2840
2841
  */
2841
- public OnPaste(cb:Fit.Controls.DropDownTypeDefs.PasteEventHandler<this>):void;
2842
+ public Modal(val?:boolean):boolean;
2842
2843
  /**
2843
- * Open drop down menu.
2844
- * @function OpenDropDown
2844
+ * Add event handler fired when dialog is closed or dismissed.
2845
+ Use this event to react to dialog being closed, no matter
2846
+ the cause. Use OnDismiss event to detect when user closed it.
2847
+ Action can be suppressed by returning False.
2848
+ Function receives one argument: Sender (Fit.Controls.Dialog).
2849
+ * @function OnClose
2850
+ * @param {Fit.Controls.DialogTypeDefs.DialogEventHandler} cb - Event handler function.
2845
2851
  */
2846
- public OpenDropDown():void;
2852
+ public OnClose(cb:Fit.Controls.DialogTypeDefs.DialogEventHandler):void;
2847
2853
  /**
2848
- * Make DropDown restore scroll position and previously highlighted item when reopened.
2849
- * @function PersistView
2850
- * @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
2851
- * @returns boolean
2854
+ * Add event handler fired when dialog is being dismissed by the user.
2855
+ Action can be suppressed by returning False.
2856
+ Function receives one argument: Sender (Fit.Controls.Dialog).
2857
+ * @function OnDismiss
2858
+ * @param {Fit.Controls.DialogTypeDefs.DialogEventHandler} cb - Event handler function.
2852
2859
  */
2853
- public PersistView(val?:boolean):boolean;
2860
+ public OnDismiss(cb:Fit.Controls.DialogTypeDefs.DialogEventHandler):void;
2854
2861
  /**
2855
- * Get/set value used as a placeholder on supported browsers, to indicate expected value or action.
2856
- * @function Placeholder
2857
- * @param {string} [val=undefined] - If defined, value is set as placeholder.
2858
- * @returns string
2862
+ * Open dialog.
2863
+ * @function Open
2864
+ * @param {HTMLElement} [renderTarget=undefined] - Optional render target which can be used to render dialog to specific
2865
+ container rather than the root of the body element. This allows for
2866
+ the dialog to inherit styles from the specified render target.
2859
2867
  */
2860
- public Placeholder(val?:string):string;
2868
+ public Open(renderTarget?:HTMLElement):void;
2861
2869
  /**
2862
- * Remove selected item by value.
2863
- * @function RemoveSelection
2864
- * @param {string} value - Value of selected item to remove.
2870
+ * Remove all buttons from dialog.
2871
+ * @function RemoveAllButtons
2872
+ * @param {boolean} [dispose=undefined] - If defined, a value of True results in buttons being disposed (destroyed).
2865
2873
  */
2866
- public RemoveSelection(value:string):void;
2874
+ public RemoveAllButtons(dispose?:boolean):void;
2867
2875
  /**
2868
- * Rename title of selected item by its value.
2869
- * @function RenameSelection
2870
- * @param {string} val - Value of selected item to rename.
2871
- * @param {string} newTitle - New item title.
2876
+ * Remove button from dialog.
2877
+ * @function RemoveButton
2878
+ * @param {Fit.Controls.Button} btn - Instance of Fit.Controls.Button.
2879
+ * @param {boolean} [dispose=undefined] - If defined, a value of True results in button being disposed (destroyed).
2872
2880
  */
2873
- public RenameSelection(val:string, newTitle:string):void;
2881
+ public RemoveButton(btn:Fit.Controls.Button, dispose?:boolean):void;
2874
2882
  /**
2875
- * Clear input and display "Search.." placeholder when control receives focus.
2876
- If SearchModeOnFocus is enabled, InputEnabled will also be enabled. Disabling
2877
- SearchModeOnFocus does not disable InputEnabled.
2878
- * @function SearchModeOnFocus
2879
- * @param {boolean} [val=undefined] - If defined, True enables search mode on focus, False disables it.
2880
- * @returns boolean
2883
+ * Reset custom size (Resizable enabled) and position (Draggable enabled).
2884
+ * @function Reset
2881
2885
  */
2882
- public SearchModeOnFocus(val?:boolean):boolean;
2886
+ public Reset():void;
2883
2887
  /**
2884
- * Get/set value indicating whether control allow user to toggle Selection Mode (Visual or Text).
2885
- * @function SelectionModeToggle
2886
- * @param {boolean} [val=undefined] - If defined, True enables toggle button, False disables it.
2888
+ * Get/set flag indicating whether dialog can be resized by the user.
2889
+ * @function Resizable
2890
+ * @param {boolean} [val=undefined] - If defined, a value of True enables resizing, False disables it (default).
2887
2891
  * @returns boolean
2888
2892
  */
2889
- public SelectionModeToggle(val?:boolean):boolean;
2893
+ public Resizable(val?:boolean):boolean;
2890
2894
  /**
2891
- * Set value of text field which is automatically cleared the first time control
2892
- receives focus. Notice that this function should be called after AddSelection(..),
2893
- since adding selections causes the value of the text field to be cleared.
2894
- * @function SetInputValue
2895
- * @param {string} val - New value for text field.
2895
+ * Get/set title - returns null if not set, and null can be passed to remove title.
2896
+ * @function Title
2897
+ * @param {string | null} [val=undefined] - If specified, dialog title is updated with specified value.
2898
+ * @returns string | null
2896
2899
  */
2897
- public SetInputValue(val:string):void;
2900
+ public Title(val?:string | null):string | null;
2898
2901
  /**
2899
- * Set picker control used to add items to drop down control.
2900
- * @function SetPicker
2901
- * @param {Fit.Controls.PickerBase | null} pickerControl - Picker control extending from PickerBase.
2902
+ * Get/set dialog width - returns object with Value and Unit properties.
2903
+ * @function Width
2904
+ * @param {number} [val=undefined] - If defined, dialog width is updated to specified value. A value of -1 resets width (auto sizing).
2905
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, dialog width is updated to specified CSS unit.
2906
+ * @returns Fit.TypeDefs.CssValue
2902
2907
  */
2903
- public SetPicker(pickerControl:Fit.Controls.PickerBase | null):void;
2908
+ public Width(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
2909
+ // Functions defined by Fit.Controls.Component
2904
2910
  /**
2905
- * Get/set flag indicating whether to use Text Selection Mode (true) or Visual Selection Mode (false).
2906
- Visual Selection Mode is the default way selected items are displayed, but it may result in control
2907
- changing dimensions as items are added/removed. Text Selection Mode prevents this and gives the
2908
- user a traditional DropDown control instead.
2909
- * @function TextSelectionMode
2910
- * @param {boolean} [val=undefined] - If defined, True enables Text Selection Mode, False disables it (Visual Selection Mode).
2911
- * @param {Fit.Controls.DropDownTypeDefs.SelectionToStringCallback<this>} [cb=undefined] - If defined, function will be called with DropDown being passed as an argument when selection text
2912
- needs to be updated. Function is expected to return a string representation of the selected items.
2913
- * @returns boolean
2911
+ * Destroys control to free up memory.
2912
+ Make sure to call Dispose() on Component which can be done like so:
2913
+ this.Dispose = Fit.Core.CreateOverride(this.Dispose, function()
2914
+ {
2915
+      // Add control specific dispose logic here
2916
+      base(); // Call Dispose on Component
2917
+ });.
2918
+ * @function Dispose
2914
2919
  */
2915
- public TextSelectionMode(val?:boolean, cb?:Fit.Controls.DropDownTypeDefs.SelectionToStringCallback<this>):boolean;
2920
+ public Dispose():void;
2916
2921
  /**
2917
- * Update title of selected items based on data in associated picker control.
2918
- An array of updated items are returned. Each object has the following properties:
2919
- - Title: string (Updated title)
2920
- - Value: string (Unique item value)
2921
- - Exists: boolean (True if item still exists, False if not)
2922
- This is useful if selections are stored in a database, and
2923
- available items may have their titles changed over time. Invoking
2924
- this function will ensure that the selection displayed to the user
2925
- reflects the actual state of data in the picker control. Be aware
2926
- that this function can only update selected items if a picker has been
2927
- associated (see SetPicker(..)), and it contains the data from which
2928
- selected items are to be updated.
2929
- Items that no longer exists in picker's data will not automatically
2930
- be removed.
2931
- * @function UpdateSelected
2932
- * @returns Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem[]
2922
+ * Get DOMElement representing control.
2923
+ * @function GetDomElement
2924
+ * @returns HTMLElement
2933
2925
  */
2934
- public UpdateSelected():Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem[];
2935
- // Functions defined by Fit.Controls.ControlBase
2926
+ public GetDomElement():HTMLElement;
2936
2927
  /**
2937
- * Add CSS class to DOMElement representing control.
2938
- * @function AddCssClass
2939
- * @param {string} val - CSS class to add.
2928
+ * Get unique Control ID.
2929
+ * @function GetId
2930
+ * @returns string
2940
2931
  */
2941
- public AddCssClass(val:string):void;
2932
+ public GetId():string;
2942
2933
  /**
2943
- * Set callback function used to perform on-the-fly validation against control.
2944
- * @function AddValidationRule
2945
- * @param {Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>} validator - Function receiving an instance of the control.
2946
- A value of False or a non-empty string with an
2947
- error message must be returned if value is invalid.
2934
+ * Render control, either inline or to element specified.
2935
+ * @function Render
2936
+ * @param {HTMLElement} [toElement=undefined] - If defined, control is rendered to this element.
2948
2937
  */
2949
- public AddValidationRule(validator:Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>):void;
2938
+ public Render(toElement?:HTMLElement):void;
2939
+ }
2940
+ /**
2941
+ * Simple interface for controlling Prompt, Confirm, and Alert dialogs.
2942
+ * @class [Fit.Controls.DialogInterface DialogInterface]
2943
+ */
2944
+ class DialogInterface
2945
+ {
2946
+ // Functions defined by Fit.Controls.DialogInterface
2950
2947
  /**
2951
- * Set regular expression used to perform on-the-fly validation against control value, as returned by the Value() function.
2952
- * @function AddValidationRule
2953
- * @param {RegExp} validator - Regular expression to validate value against.
2954
- * @param {string} [errorMessage=undefined] - Optional error message displayed if value validation fails.
2948
+ * Cancel dialog - equivalent to clicking the Cancel button, or the OK button on an Alert dialog.
2949
+ * @function Cancel
2955
2950
  */
2956
- public AddValidationRule(validator:RegExp, errorMessage?:string):void;
2951
+ public Cancel():void;
2957
2952
  /**
2958
- * Get/set value indicating whether control is always considered dirty. This
2959
- comes in handy when programmatically changing a value of a control on behalf
2960
- of the user. Some applications may choose to only save values from dirty controls.
2961
- * @function AlwaysDirty
2962
- * @param {boolean} [val=undefined] - If defined, Always Dirty is enabled/disabled.
2963
- * @returns boolean
2953
+ * Confirm dialog - equivalent to clicking the OK button.
2954
+ * @function Confirm
2964
2955
  */
2965
- public AlwaysDirty(val?:boolean):boolean;
2956
+ public Confirm():void;
2966
2957
  /**
2967
- * Set flag indicating whether control should post back changes automatically when value is changed.
2968
- * @function AutoPostBack
2969
- * @param {boolean} [val=undefined] - If defined, True enables auto post back, False disables it.
2970
- * @returns boolean
2958
+ * Dismiss dialog without taking any action.
2959
+ * @function Dismiss
2971
2960
  */
2972
- public AutoPostBack(val?:boolean):boolean;
2961
+ public Dismiss():void;
2962
+ }
2963
+ /**
2964
+ *
2965
+ * @namespace [Fit.Controls.DialogTypeDefs DialogTypeDefs]
2966
+ */
2967
+ namespace DialogTypeDefs
2968
+ {
2969
+ // Functions defined by Fit.Controls.DialogTypeDefs
2973
2970
  /**
2974
- * Clear control value.
2975
- * @function Clear
2971
+ * Confirmation dialog callback.
2972
+ * @callback ConfirmCallback
2973
+ * @param {boolean} confirmed - True if OK button is clicked, otherwise False.
2976
2974
  */
2977
- public Clear():void;
2975
+ type ConfirmCallback = (confirmed:boolean) => void;
2978
2976
  /**
2979
- * Get/set value indicating whether control is enabled or disabled.
2980
- A disabled control's value and state is still included on postback, if part of a form.
2981
- * @function Enabled
2982
- * @param {boolean} [val=undefined] - If defined, True enables control (default), False disables control.
2983
- * @returns boolean
2977
+ * Dialog event handler.
2978
+ * @callback DialogEventHandler
2979
+ * @param {Fit.Controls.Dialog} sender - Instance of Dialog.
2984
2980
  */
2985
- public Enabled(val?:boolean):boolean;
2981
+ type DialogEventHandler = (sender:Fit.Controls.Dialog) => void;
2986
2982
  /**
2987
- * Get/set value indicating whether control has focus.
2988
- Control must be rooted in DOM and be visible for control to gain focus.
2989
- * @function Focused
2990
- * @param {boolean} [value=undefined] - If defined, True assigns focus, False removes focus (blur).
2991
- * @returns boolean
2983
+ * Prompt dialog callback.
2984
+ * @callback PromptCallback
2985
+ * @param {string | null} value - String value entered if OK button is clicked, Null if prompt is canceled.
2992
2986
  */
2993
- public Focused(value?:boolean):boolean;
2987
+ type PromptCallback = (value:string | null) => void;
2988
+ }
2989
+ /**
2990
+ * Drop Down Menu control allowing for single and multi selection.
2991
+ Supports data selection using any control extending from Fit.Controls.PickerBase.
2992
+ This control is extending from Fit.Controls.ControlBase.
2993
+ * @class [Fit.Controls.DropDown DropDown]
2994
+ */
2995
+ class DropDown
2996
+ {
2997
+ // Functions defined by Fit.Controls.DropDown
2994
2998
  /**
2995
- * Check whether CSS class is found on DOMElement representing control.
2996
- * @function HasCssClass
2997
- * @param {string} val - CSS class to check for.
2998
- * @returns boolean
2999
+ * Add selection to control.
3000
+ * @function AddSelection
3001
+ * @param {string} title - Item title.
3002
+ * @param {string} value - Item value.
3003
+ * @param {boolean} [valid=true] - Flag indicating whether selection is valid or not. Invalid selections are highlighted and
3004
+ not included when selections are retrived using Value() function, and not considered when
3005
+ IsDirty() is called to determine whether control value has been changed by user.
3006
+ GetSelections(true) can be used to retrive all items, including invalid selections.
2999
3007
  */
3000
- public HasCssClass(val:string):boolean;
3008
+ public AddSelection(title:string, value:string, valid?:boolean):void;
3001
3009
  /**
3002
- * Get/set control height - returns object with Value and Unit properties.
3003
- * @function Height
3004
- * @param {number} [val=undefined] - If defined, control height is updated to specified value. A value of -1 resets control height.
3005
- * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, control height is updated to specified CSS unit.
3006
- * @returns Fit.TypeDefs.CssValue
3010
+ * Clear text field.
3011
+ * @function ClearInput
3007
3012
  */
3008
- public Height(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
3013
+ public ClearInput():void;
3009
3014
  /**
3010
- * Get value indicating whether user has changed control value.
3011
- * @function IsDirty
3012
- * @returns boolean
3015
+ * Clear selections.
3016
+ * @function ClearSelections
3013
3017
  */
3014
- public IsDirty():boolean;
3018
+ public ClearSelections():void;
3015
3019
  /**
3016
- * Get value indicating whether control value is valid.
3017
- Control value is considered invalid if control is required, but no value is set,
3018
- or if control value does not match regular expression set using SetValidationExpression(..).
3019
- * @function IsValid
3020
- * @returns boolean
3020
+ * Close drop down menu.
3021
+ * @function CloseDropDown
3021
3022
  */
3022
- public IsValid():boolean;
3023
+ public CloseDropDown():void;
3023
3024
  /**
3024
- * Get/set value indicating whether control initially appears as valid, even
3025
- though it is not. It will appear invalid once the user touches the control,
3026
- or when control value is validated using Fit.Controls.ValidateAll(..).
3027
- * @function LazyValidation
3028
- * @param {boolean} [val=undefined] - If defined, Lazy Validation is enabled/disabled.
3025
+ * Get/set value indicating whether boundary/collision detection is enabled or not (off by default).
3026
+ This may cause drop down to open upwards if sufficient space is not available below control.
3027
+ If control is contained in a scrollable parent, this will be considered the active viewport,
3028
+ and as such define the active boundaries - unless relativeToViewport is set to True, in which
3029
+ case the actual browser viewport will be used.
3030
+ * @function DetectBoundaries
3031
+ * @param {boolean} [val=undefined] - If defined, True enables collision detection, False disables it (default).
3032
+ * @param {boolean} [relativeToViewport=false] - If defined, True results in viewport being considered the container to which available space is determined.
3033
+ This also results in DropDown menu being positioned with position:fixed, allowing it to escape a container
3034
+ with overflow (e.g. overflow:auto|hidden|scroll). Be aware though that this does not work reliably in combination
3035
+ with CSS animation and CSS transform as it creates a new stacking context to which position:fixed becomes relative.
3036
+ A value of False (default) results in available space being determined relative to the boundaries of the
3037
+ control's scroll parent. The DropDown menu will stay within its container and not overflow it.
3029
3038
  * @returns boolean
3030
3039
  */
3031
- public LazyValidation(val?:boolean):boolean;
3040
+ public DetectBoundaries(val?:boolean, relativeToViewport?:boolean):boolean;
3032
3041
  /**
3033
- * Register OnBlur event handler which is invoked when control loses focus.
3034
- * @function OnBlur
3035
- * @param {Fit.Controls.ControlBaseTypeDefs.BaseEvent<this>} cb - Event handler function which accepts Sender (ControlBase).
3042
+ * Create instance of DropDown control.
3043
+ * @function DropDown
3044
+ * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
3036
3045
  */
3037
- public OnBlur(cb:Fit.Controls.ControlBaseTypeDefs.BaseEvent<this>):void;
3046
+ constructor(ctlId?:string);
3038
3047
  /**
3039
- * Register OnChange event handler which is invoked when control value is changed either programmatically or by user.
3040
- * @function OnChange
3041
- * @param {Fit.Controls.ControlBaseTypeDefs.BaseEvent<this>} cb - Event handler function which accepts Sender (ControlBase).
3048
+ * Get/set max height of drop down - returns object with Value (number) and Unit (string) properties.
3049
+ * @function DropDownMaxHeight
3050
+ * @param {number} [value=undefined] - If defined, max height is updated to specified value. A value of -1 forces picker to fit height to content.
3051
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=undefined] - If defined, max height is updated to specified CSS unit, otherwise px is assumed.
3052
+ * @returns Fit.TypeDefs.CssValue
3042
3053
  */
3043
- public OnChange(cb:Fit.Controls.ControlBaseTypeDefs.BaseEvent<this>):void;
3054
+ public DropDownMaxHeight(value?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
3044
3055
  /**
3045
- * Register OnFocus event handler which is invoked when control gains focus.
3046
- * @function OnFocus
3047
- * @param {Fit.Controls.ControlBaseTypeDefs.BaseEvent<this>} cb - Event handler function which accepts Sender (ControlBase).
3056
+ * Get/set max width of drop down - returns object with Value (number) and Unit (string) properties.
3057
+ * @function DropDownMaxWidth
3058
+ * @param {number} [value=undefined] - If defined, max width is updated to specified value. A value of -1 forces drop down to use control width.
3059
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=undefined] - If defined, max width is updated to specified CSS unit, otherwise px is assumed.
3060
+ * @returns Fit.TypeDefs.CssValue
3048
3061
  */
3049
- public OnFocus(cb:Fit.Controls.ControlBaseTypeDefs.BaseEvent<this>):void;
3062
+ public DropDownMaxWidth(value?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
3050
3063
  /**
3051
- * Remove all validation rules.
3052
- * @function RemoveAllValidationRules
3064
+ * Get item currently highlighted in picker control.
3065
+ Returns an object with Title (string), Value (string),
3066
+ and Valid (boolean) properties if found, otherwise Null.
3067
+ * @function GetHighlighted
3068
+ * @returns Fit.Controls.DropDownTypeDefs.DropDownItem | null
3053
3069
  */
3054
- public RemoveAllValidationRules():void;
3070
+ public GetHighlighted():Fit.Controls.DropDownTypeDefs.DropDownItem | null;
3055
3071
  /**
3056
- * Remove CSS class from DOMElement representing control.
3057
- * @function RemoveCssClass
3058
- * @param {string} val - CSS class to remove.
3072
+ * Get input value.
3073
+ * @function GetInputValue
3074
+ * @returns string
3059
3075
  */
3060
- public RemoveCssClass(val:string):void;
3076
+ public GetInputValue():string;
3061
3077
  /**
3062
- * Remove validation function used to perform on-the-fly validation against control.
3063
- * @function RemoveValidationRule
3064
- * @param {Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>} validator - Validation function registered using AddValidationRule(..).
3078
+ * Get picker control used to add items to drop down control.
3079
+ * @function GetPicker
3080
+ * @returns Fit.Controls.PickerBase
3065
3081
  */
3066
- public RemoveValidationRule(validator:Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>):void;
3082
+ public GetPicker():Fit.Controls.PickerBase;
3067
3083
  /**
3068
- * Remove regular expression used to perform on-the-fly validation against control value.
3069
- * @function RemoveValidationRule
3070
- * @param {RegExp} validator - Regular expression registered using AddValidationRule(..).
3084
+ * Get selected item by value - returns object with Title (string), Value (string), and Valid (boolean) properties if found, otherwise Null is returned.
3085
+ * @function GetSelectionByValue
3086
+ * @param {string} val - Value of selected item to retrive.
3087
+ * @returns Fit.Controls.DropDownTypeDefs.DropDownItem | null
3071
3088
  */
3072
- public RemoveValidationRule(validator:RegExp):void;
3089
+ public GetSelectionByValue(val:string):Fit.Controls.DropDownTypeDefs.DropDownItem | null;
3073
3090
  /**
3074
- * Get/set value indicating whether control is required to be set.
3075
- * @function Required
3076
- * @param {boolean} [val=undefined] - If defined, control required feature is enabled/disabled.
3077
- * @returns boolean
3091
+ * Get selected items - returned array contain objects with Title (string), Value (string), and Valid (boolean) properties.
3092
+ * @function GetSelections
3093
+ * @param {boolean} [includeInvalid=false] - Flag indicating whether invalid selection should be included or not.
3094
+ * @returns Fit.Controls.DropDownTypeDefs.DropDownItem[]
3078
3095
  */
3079
- public Required(val?:boolean):boolean;
3096
+ public GetSelections(includeInvalid?:boolean):Fit.Controls.DropDownTypeDefs.DropDownItem[];
3080
3097
  /**
3081
- * Get/set scope to which control belongs - this is used to validate multiple
3082
- controls at once using Fit.Controls.ValidateAll(scope) or Fit.Controls.DirtyCheckAll(scope).
3083
- * @function Scope
3084
- * @param {string} [val=undefined] - If defined, control scope is updated.
3085
- * @returns string
3098
+ * Make DropDown highlight first selectable item when opened.
3099
+ * @function HighlightFirst
3100
+ * @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
3101
+ * @returns boolean
3086
3102
  */
3087
- public Scope(val?:string):string;
3103
+ public HighlightFirst(val?:boolean):boolean;
3088
3104
  /**
3089
- * DEPRECATED! Please use AddValidationRule(..) instead.
3090
- Set callback function used to perform on-the-fly validation against control value.
3091
- * @function SetValidationCallback
3092
- * @param {Function | null} cb - Function receiving control value - must return True if value is valid, otherwise False.
3093
- * @param {string} [errorMsg=undefined] - If defined, specified error message is displayed when user clicks or hovers validation error indicator.
3105
+ * Get/set value indicating whether input is enabled.
3106
+ * @function InputEnabled
3107
+ * @param {boolean} [val=undefined] - If defined, True enables input, False disables it.
3108
+ * @returns boolean
3094
3109
  */
3095
- public SetValidationCallback(cb:Function | null, errorMsg?:string):void;
3110
+ public InputEnabled(val?:boolean):boolean;
3096
3111
  /**
3097
- * DEPRECATED! Please use AddValidationRule(..) instead.
3098
- Set regular expression used to perform on-the-fly validation against control value.
3099
- * @function SetValidationExpression
3100
- * @param {RegExp | null} regEx - Regular expression to validate against.
3101
- * @param {string} [errorMsg=undefined] - If defined, specified error message is displayed when user clicks or hovers validation error indicator.
3112
+ * Get/set mouse over text shown for invalid selections.
3113
+ * @function InvalidSelectionMessage
3114
+ * @param {string} [msg=undefined] - If defined, error message for invalid selections are set.
3115
+ * @returns string
3102
3116
  */
3103
- public SetValidationExpression(regEx:RegExp | null, errorMsg?:string):void;
3117
+ public InvalidSelectionMessage(msg?:string):string;
3104
3118
  /**
3105
- * DEPRECATED! Please use AddValidationRule(..) instead.
3106
- Set callback function used to perform on-the-fly validation against control value.
3107
- * @function SetValidationHandler
3108
- * @param {Function | null} cb - Function receiving an instance of the control and its value.
3109
- An error message string must be returned if value is invalid,
3110
- otherwise Null or an empty string if the value is valid.
3119
+ * Get flag indicating whether drop down is open or not.
3120
+ * @function IsDropDownOpen
3121
+ * @returns boolean
3111
3122
  */
3112
- public SetValidationHandler(cb:Function | null):void;
3123
+ public IsDropDownOpen():boolean;
3113
3124
  /**
3114
- * Get/set value as if it was changed by the user. Contrary to Value(..), this function will never reset the dirty state.
3115
- Restrictions/filtering/modifications may be enforced just as the UI control might do, e.g. prevent the use of certain
3116
- characters, or completely ignore input if not allowed. It may also allow invalid values such as a partially entered date
3117
- value. The intention with UserValue(..) is to mimic the behaviour of what the user can do with the user interface control.
3118
- For picker controls the value format is equivalent to the one dictated by the Value(..) function.
3119
- * @function UserValue
3120
- * @param {string} [val=undefined] - If defined, value is inserted into control.
3121
- * @returns string
3125
+ * Get/set flag indicating whether control allows for multiple selections.
3126
+ * @function MultiSelectionMode
3127
+ * @param {boolean} [val=undefined] - If defined, True enables multi selection mode, False disables it.
3128
+ * @returns boolean
3122
3129
  */
3123
- public UserValue(val?:string):string;
3130
+ public MultiSelectionMode(val?:boolean):boolean;
3124
3131
  /**
3125
- * Get/set control value.
3126
- For controls supporting multiple selections: Set value by providing a string in one the following formats:
3127
- title1=val1[;title2=val2[;title3=val3]] or val1[;val2[;val3]].
3128
- If Title or Value contains reserved characters (semicolon or equality sign), these most be URIEncoded.
3129
- Selected items are returned in the first format described, also with reserved characters URIEncoded.
3130
- Providing a new value to this function results in OnChange being fired.
3131
- * @function Value
3132
- * @param {string} [val=undefined] - If defined, value is inserted into control.
3133
- * @param {boolean} [preserveDirtyState=false] - If defined, True prevents dirty state from being reset, False (default) resets the dirty state.
3134
- If dirty state is reset (default), the control value will be compared against the value passed,
3135
- to determine whether it has been changed by the user or not, when IsDirty() is called.
3136
- * @returns string
3132
+ * Add event handler fired when drop down menu is closed.
3133
+ Function receives one argument: Sender (Fit.Controls.DropDown).
3134
+ * @function OnClose
3135
+ * @param {Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>} cb - Event handler function.
3137
3136
  */
3138
- public Value(val?:string, preserveDirtyState?:boolean):string;
3137
+ public OnClose(cb:Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>):void;
3139
3138
  /**
3140
- * Get/set value indicating whether control is visible.
3141
- * @function Visible
3142
- * @param {boolean} [val=undefined] - If defined, control visibility is updated.
3143
- * @returns boolean
3139
+ * Add event handler fired when input value is changed.
3140
+ Function receives two arguments:
3141
+ Sender (Fit.Controls.DropDown) and Value (string).
3142
+ * @function OnInputChanged
3143
+ * @param {Fit.Controls.DropDownTypeDefs.InputChangedEventHandler<this>} cb - Event handler function.
3144
3144
  */
3145
- public Visible(val?:boolean):boolean;
3145
+ public OnInputChanged(cb:Fit.Controls.DropDownTypeDefs.InputChangedEventHandler<this>):void;
3146
3146
  /**
3147
- * Get/set control width - returns object with Value and Unit properties.
3148
- * @function Width
3149
- * @param {number} [val=undefined] - If defined, control width is updated to specified value. A value of -1 resets control width.
3150
- * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, control width is updated to specified CSS unit.
3151
- * @returns Fit.TypeDefs.CssValue
3147
+ * Add event handler fired when drop down menu is opened.
3148
+ Function receives one argument: Sender (Fit.Controls.DropDown).
3149
+ * @function OnOpen
3150
+ * @param {Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>} cb - Event handler function.
3152
3151
  */
3153
- public Width(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
3154
- // Functions defined by Fit.Controls.Component
3152
+ public OnOpen(cb:Fit.Controls.DropDownTypeDefs.InteractionEventHandler<this>):void;
3155
3153
  /**
3156
- * Destroys control to free up memory.
3157
- Make sure to call Dispose() on Component which can be done like so:
3158
- this.Dispose = Fit.Core.CreateOverride(this.Dispose, function()
3159
- {
3160
-      // Add control specific dispose logic here
3161
-      base(); // Call Dispose on Component
3162
- });.
3163
- * @function Dispose
3154
+ * Add event handler fired when text is pasted into input field.
3155
+ Function receives two arguments:
3156
+ Sender (Fit.Controls.DropDown) and Value (string).
3157
+ Return False to cancel event and change, and prevent OnInputChanged from firing.
3158
+ * @function OnPaste
3159
+ * @param {Fit.Controls.DropDownTypeDefs.PasteEventHandler<this>} cb - Event handler function.
3164
3160
  */
3165
- public Dispose():void;
3161
+ public OnPaste(cb:Fit.Controls.DropDownTypeDefs.PasteEventHandler<this>):void;
3166
3162
  /**
3167
- * Get DOMElement representing control.
3168
- * @function GetDomElement
3169
- * @returns HTMLElement
3163
+ * Open drop down menu.
3164
+ * @function OpenDropDown
3170
3165
  */
3171
- public GetDomElement():HTMLElement;
3166
+ public OpenDropDown():void;
3172
3167
  /**
3173
- * Get unique Control ID.
3174
- * @function GetId
3175
- * @returns string
3168
+ * Make DropDown restore scroll position and previously highlighted item when reopened.
3169
+ * @function PersistView
3170
+ * @param {boolean} [val=undefined] - If set, True enables feature, False disables it (default).
3171
+ * @returns boolean
3176
3172
  */
3177
- public GetId():string;
3173
+ public PersistView(val?:boolean):boolean;
3178
3174
  /**
3179
- * Render control, either inline or to element specified.
3180
- * @function Render
3181
- * @param {HTMLElement} [toElement=undefined] - If defined, control is rendered to this element.
3175
+ * Get/set value used as a placeholder on supported browsers, to indicate expected value or action.
3176
+ * @function Placeholder
3177
+ * @param {string} [val=undefined] - If defined, value is set as placeholder.
3178
+ * @returns string
3182
3179
  */
3183
- public Render(toElement?:HTMLElement):void;
3184
- }
3185
- /**
3186
- *
3187
- * @namespace [Fit.Controls.DropDownTypeDefs DropDownTypeDefs]
3188
- */
3189
- namespace DropDownTypeDefs
3190
- {
3191
- // Functions defined by Fit.Controls.DropDownTypeDefs
3180
+ public Placeholder(val?:string):string;
3192
3181
  /**
3193
- * Input changed event handler.
3194
- * @template TypeOfThis
3195
- * @callback InputChangedEventHandler
3196
- * @param {TypeOfThis} sender - Instance of control.
3197
- * @param {string} value - Input value.
3182
+ * Remove selected item by value.
3183
+ * @function RemoveSelection
3184
+ * @param {string} value - Value of selected item to remove.
3198
3185
  */
3199
- type InputChangedEventHandler<TypeOfThis> = (sender:TypeOfThis, value:string) => void;
3186
+ public RemoveSelection(value:string):void;
3200
3187
  /**
3201
- * Event handler.
3202
- * @template TypeOfThis
3203
- * @callback InteractionEventHandler
3204
- * @param {TypeOfThis} sender - Instance of control.
3188
+ * Rename title of selected item by its value.
3189
+ * @function RenameSelection
3190
+ * @param {string} val - Value of selected item to rename.
3191
+ * @param {string} newTitle - New item title.
3205
3192
  */
3206
- type InteractionEventHandler<TypeOfThis> = (sender:TypeOfThis) => void;
3193
+ public RenameSelection(val:string, newTitle:string):void;
3207
3194
  /**
3208
- * Paste event handler.
3209
- * @template TypeOfThis
3210
- * @callback PasteEventHandler
3211
- * @param {TypeOfThis} sender - Instance of control.
3212
- * @param {string} value - Value pasted into input field.
3213
- * @returns boolean | void
3195
+ * Clear input and display "Search.." placeholder when control receives focus.
3196
+ If SearchModeOnFocus is enabled, InputEnabled will also be enabled. Disabling
3197
+ SearchModeOnFocus does not disable InputEnabled.
3198
+ * @function SearchModeOnFocus
3199
+ * @param {boolean} [val=undefined] - If defined, True enables search mode on focus, False disables it.
3200
+ * @returns boolean
3214
3201
  */
3215
- type PasteEventHandler<TypeOfThis> = (sender:TypeOfThis, value:string) => boolean | void;
3202
+ public SearchModeOnFocus(val?:boolean):boolean;
3216
3203
  /**
3217
- * Callback responsible for constructing string value representing selected items.
3218
- * @template TypeOfThis
3219
- * @callback SelectionToStringCallback
3220
- * @param {TypeOfThis} sender - Instance of control.
3221
- * @returns string
3204
+ * Get/set value indicating whether control allow user to toggle Selection Mode (Visual or Text).
3205
+ * @function SelectionModeToggle
3206
+ * @param {boolean} [val=undefined] - If defined, True enables toggle button, False disables it.
3207
+ * @returns boolean
3222
3208
  */
3223
- type SelectionToStringCallback<TypeOfThis> = (sender:TypeOfThis) => string;
3209
+ public SelectionModeToggle(val?:boolean):boolean;
3224
3210
  /**
3225
- * DropDown item.
3226
- * @class [Fit.Controls.DropDownTypeDefs.DropDownItem DropDownItem]
3211
+ * Set value of text field which is automatically cleared the first time control
3212
+ receives focus. Notice that this function should be called after AddSelection(..),
3213
+ since adding selections causes the value of the text field to be cleared.
3214
+ * @function SetInputValue
3215
+ * @param {string} val - New value for text field.
3227
3216
  */
3228
- class DropDownItem
3229
- {
3230
- // Properties defined by Fit.Controls.DropDownTypeDefs.DropDownItem
3231
- /**
3232
- * Item title.
3233
- * @member {string} Title
3234
- */
3235
- Title:string;
3236
- /**
3237
- * Value indicating whether item is a valid selection.
3238
- * @member {boolean} Valid
3239
- */
3240
- Valid:boolean;
3241
- /**
3242
- * Unique item value.
3243
- * @member {string} Value
3244
- */
3245
- Value:string;
3246
- }
3217
+ public SetInputValue(val:string):void;
3247
3218
  /**
3248
- * DropDown item.
3249
- * @class [Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem UpdatedDropDownItem]
3219
+ * Set picker control used to add items to drop down control.
3220
+ * @function SetPicker
3221
+ * @param {Fit.Controls.PickerBase | null} pickerControl - Picker control extending from PickerBase.
3250
3222
  */
3251
- class UpdatedDropDownItem
3252
- {
3253
- // Properties defined by Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem
3254
- /**
3255
- * Value indicating whether item still exists or not.
3256
- * @member {boolean} Exists
3257
- */
3258
- Exists:boolean;
3259
- /**
3260
- * Updated item title.
3261
- * @member {string} Title
3262
- */
3263
- Title:string;
3264
- /**
3265
- * unique item value.
3266
- * @member {string} Value
3267
- */
3268
- Value:string;
3269
- }
3270
- }
3271
- /**
3272
- * Control allowing for files to be selected locally and uploaded asynchronously.
3273
- Extending from Fit.Controls.ControlBase.
3274
- * @class [Fit.Controls.FilePicker FilePicker]
3275
- */
3276
- class FilePicker
3277
- {
3278
- // Functions defined by Fit.Controls.FilePicker
3223
+ public SetPicker(pickerControl:Fit.Controls.PickerBase | null):void;
3279
3224
  /**
3280
- * Get/set value indicating whether control automatically starts upload process when files are selected.
3281
- * @function AutoUpload
3282
- * @param {boolean} [val=undefined] - If specified, True enables auto upload, False disables it (default).
3225
+ * Get/set flag indicating whether to use Text Selection Mode (true) or Visual Selection Mode (false).
3226
+ Visual Selection Mode is the default way selected items are displayed, but it may result in control
3227
+ changing dimensions as items are added/removed. Text Selection Mode prevents this and gives the
3228
+ user a traditional DropDown control instead.
3229
+ * @function TextSelectionMode
3230
+ * @param {boolean} [val=undefined] - If defined, True enables Text Selection Mode, False disables it (Visual Selection Mode).
3231
+ * @param {Fit.Controls.DropDownTypeDefs.SelectionToStringCallback<this>} [cb=undefined] - If defined, function will be called with DropDown being passed as an argument when selection text
3232
+ needs to be updated. Function is expected to return a string representation of the selected items.
3283
3233
  * @returns boolean
3284
3234
  */
3285
- public AutoUpload(val?:boolean):boolean;
3286
- /**
3287
- * Get/set button text.
3288
- * @function ButtonText
3289
- * @param {string} [val=undefined] - If defined, button text is set to specified value.
3290
- * @returns string
3291
- */
3292
- public ButtonText(val?:string):string;
3235
+ public TextSelectionMode(val?:boolean, cb?:Fit.Controls.DropDownTypeDefs.SelectionToStringCallback<this>):boolean;
3293
3236
  /**
3294
- * Get/set drop zone text.
3295
- * @function DropZoneText
3296
- * @param {string} [val=undefined] - If defined, drop zone text is set to specified value.
3297
- * @returns string
3237
+ * Update title of selected items based on data in associated picker control.
3238
+ An array of updated items are returned. Each object has the following properties:
3239
+ - Title: string (Updated title)
3240
+ - Value: string (Unique item value)
3241
+ - Exists: boolean (True if item still exists, False if not)
3242
+ This is useful if selections are stored in a database, and
3243
+ available items may have their titles changed over time. Invoking
3244
+ this function will ensure that the selection displayed to the user
3245
+ reflects the actual state of data in the picker control. Be aware
3246
+ that this function can only update selected items if a picker has been
3247
+ associated (see SetPicker(..)), and it contains the data from which
3248
+ selected items are to be updated.
3249
+ Items that no longer exists in picker's data will not automatically
3250
+ be removed.
3251
+ * @function UpdateSelected
3252
+ * @returns Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem[]
3298
3253
  */
3299
- public DropZoneText(val?:string):string;
3254
+ public UpdateSelected():Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem[];
3255
+ // Functions defined by Fit.Controls.ControlBase
3300
3256
  /**
3301
- * Get/set value indicating whether control is enabled or not.
3302
- Any files added to the control prior to being disabled, will
3303
- not be included with a traditional postback to the server.
3304
- * @function Enabled
3305
- * @param {boolean} [val=undefined] - If specified, True enables control, False disables it.
3306
- * @returns boolean
3257
+ * Add CSS class to DOMElement representing control.
3258
+ * @function AddCssClass
3259
+ * @param {string} val - CSS class to add.
3307
3260
  */
3308
- public Enabled(val?:boolean):boolean;
3261
+ public AddCssClass(val:string):void;
3309
3262
  /**
3310
- * Create instance of FilePicker control.
3311
- * @function FilePicker
3312
- * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
3263
+ * Set callback function used to perform on-the-fly validation against control.
3264
+ * @function AddValidationRule
3265
+ * @param {Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>} validator - Function receiving an instance of the control.
3266
+ A value of False or a non-empty string with an
3267
+ error message must be returned if value is invalid.
3313
3268
  */
3314
- constructor(ctlId?:string);
3269
+ public AddValidationRule(validator:Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>):void;
3315
3270
  /**
3316
- * Get collection of selected files. Each file is represented as an object with the following members:
3317
- - Filename:string (Name of selected file)
3318
- - Type:string (Mime type for selected file)
3319
- - Size:integer (File size in bytes)
3320
- - Id:string (Unique file ID)
3321
- - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3322
- - Progress:integer (Value from 0-100 indicating upload progress, a value of -1 when not uploading/uploaded)
3323
- - FileObject:File (Native JS File object representing selected file)
3324
- - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3325
- - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3326
- NOTICE: The following properties/functions are not available in Legacy Mode: Type, Size, FileObject, GetImagePreview().
3327
- * @function GetFiles
3328
- * @returns Fit.Controls.FilePickerTypeDefs.File[]
3271
+ * Set regular expression used to perform on-the-fly validation against control value, as returned by the Value() function.
3272
+ * @function AddValidationRule
3273
+ * @param {RegExp} validator - Regular expression to validate value against.
3274
+ * @param {string} [errorMessage=undefined] - Optional error message displayed if value validation fails.
3329
3275
  */
3330
- public GetFiles():Fit.Controls.FilePickerTypeDefs.File[];
3276
+ public AddValidationRule(validator:RegExp, errorMessage?:string):void;
3331
3277
  /**
3332
- * Get value indicating whether control is in legacy mode (old fashion upload control).
3333
- * @function IsLegacyModeEnabled
3278
+ * Get/set value indicating whether control is always considered dirty. This
3279
+ comes in handy when programmatically changing a value of a control on behalf
3280
+ of the user. Some applications may choose to only save values from dirty controls.
3281
+ * @function AlwaysDirty
3282
+ * @param {boolean} [val=undefined] - If defined, Always Dirty is enabled/disabled.
3334
3283
  * @returns boolean
3335
3284
  */
3336
- public IsLegacyModeEnabled():boolean;
3285
+ public AlwaysDirty(val?:boolean):boolean;
3337
3286
  /**
3338
- * Get/set flag indicating whether control allows for multiple selections.
3339
- * @function MultiSelectionMode
3340
- * @param {boolean} [val=undefined] - If defined, True enables multi selection mode, False disables it.
3287
+ * Set flag indicating whether control should post back changes automatically when value is changed.
3288
+ * @function AutoPostBack
3289
+ * @param {boolean} [val=undefined] - If defined, True enables auto post back, False disables it.
3341
3290
  * @returns boolean
3342
3291
  */
3343
- public MultiSelectionMode(val?:boolean):boolean;
3344
- /**
3345
- * Add event handler fired when all files selected have been fully processed.
3346
- Be aware that this event fires even if some files were not uploaded successfully.
3347
- At this point files returned from GetFiles() contains a ServerResponse:string property
3348
- containing the response from the server. This property remains Null in case of errors.
3349
- Function receives one argument: Sender (Fit.Controls.FlePicker).
3350
- * @function OnCompleted
3351
- * @param {Fit.Controls.FilePickerTypeDefs.CompletedEventHandler} cb - Event handler function.
3352
- */
3353
- public OnCompleted(cb:Fit.Controls.FilePickerTypeDefs.CompletedEventHandler):void;
3354
- /**
3355
- * Add event handler fired for a given file if the upload process failed.
3356
- Function receives two arguments:
3357
- Sender (Fit.Controls.FlePicker) and EventArgs object.
3358
- EventArgs object contains the following members:
3359
- - Filename:string (Name of given file)
3360
- - Type:string (Mime type for given file)
3361
- - Size:integer (File size in bytes)
3362
- - Id:string (Unique file ID)
3363
- - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3364
- - Progress:integer (A value from 0-100 indicating how many percent of the file has been uploaded)
3365
- - FileObject:File (Native JS File object representing given file)
3366
- - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3367
- - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3368
- Be aware that Type and Size cannot be determined in Legacy Mode, and that FileObject in this
3369
- case will be Null. GetImagePreview() will also return Null in Legacy Mode.
3370
- * @function OnFailure
3371
- * @param {Fit.Controls.FilePickerTypeDefs.ProgressEventHandler} cb - Event handler function.
3372
- */
3373
- public OnFailure(cb:Fit.Controls.FilePickerTypeDefs.ProgressEventHandler):void;
3374
- /**
3375
- * Add event handler fired when the upload process for a given file is progressing.
3376
- Function receives two arguments:
3377
- Sender (Fit.Controls.FlePicker) and EventArgs object.
3378
- EventArgs object contains the following members:
3379
- - Filename:string (Name of given file)
3380
- - Type:string (Mime type for given file)
3381
- - Size:integer (File size in bytes)
3382
- - Id:string (Unique file ID)
3383
- - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3384
- - Progress:integer (A value from 0-100 indicating how many percent of the file has been uploaded)
3385
- - FileObject:File (Native JS File object representing given file)
3386
- - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3387
- - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3388
- Be aware that Type and Size cannot be determined in Legacy Mode, and that FileObject in this
3389
- case will be Null. GetImagePreview() will also return Null in Legacy Mode.
3390
- * @function OnProgress
3391
- * @param {Fit.Controls.FilePickerTypeDefs.ProgressEventHandler} cb - Event handler function.
3392
- */
3393
- public OnProgress(cb:Fit.Controls.FilePickerTypeDefs.ProgressEventHandler):void;
3394
- /**
3395
- * Add event handler fired when a file has successfully been uploaded.
3396
- Function receives two arguments:
3397
- Sender (Fit.Controls.FlePicker) and EventArgs object.
3398
- EventArgs object contains the following members:
3399
- - Filename:string (Name of given file)
3400
- - Type:string (Mime type for given file)
3401
- - Size:integer (File size in bytes)
3402
- - Id:string (Unique file ID)
3403
- - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3404
- - Progress:integer (A value from 0-100 indicating how many percent of the file has been uploaded)
3405
- - FileObject:File (Native JS File object representing given file)
3406
- - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3407
- - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3408
- Be aware that Type and Size cannot be determined in Legacy Mode, and that FileObject in this
3409
- case will be Null. GetImagePreview() will also return Null in Legacy Mode.
3410
- * @function OnSuccess
3411
- * @param {Fit.Controls.FilePickerTypeDefs.ProgressEventHandler} cb - Event handler function.
3412
- */
3413
- public OnSuccess(cb:Fit.Controls.FilePickerTypeDefs.ProgressEventHandler):void;
3414
- /**
3415
- * Add event handler fired when upload is started.
3416
- Operation can be canceled by returning False.
3417
- Function receives one argument: Sender (Fit.Controls.FilePicker).
3418
- * @function OnUpload
3419
- * @param {Fit.Controls.FilePickerTypeDefs.CancelableUploadEventHandler} cb - Event handler function.
3420
- */
3421
- public OnUpload(cb:Fit.Controls.FilePickerTypeDefs.CancelableUploadEventHandler):void;
3422
- /**
3423
- * Get/set value indicating whether control is displayed as a drop zone on supported browsers or not.
3424
- * @function ShowDropZone
3425
- * @param {boolean} [val=undefined] - If specified, True enables drop zone, False disables it (default).
3426
- * @returns boolean
3427
- */
3428
- public ShowDropZone(val?:boolean):boolean;
3429
- /**
3430
- * Upload selected files. Each file will be uploaded using POST over individual HTTP connections,
3431
- and each file will be accessible from the POST data collection using the SelectedFile key.
3432
- Use the OnProgress event to monitor the upload process, or use the OnCompleted event
3433
- to be notified when all files have been fully processed.
3434
- * @function Upload
3435
- * @param {string[]} [skip=undefined] - Optional argument allowing some of the selected files to be skipped during
3436
- upload. The argument is a string array with the names of the files to skip.
3437
- */
3438
- public Upload(skip?:string[]):void;
3439
- /**
3440
- * Get/set URL to which files are uploaded when FilePicker.Upload() is called.
3441
- Multiple files will be uploaded using POST over individual HTTP connections,
3442
- and each file will be accessible from the POST data collection using the SelectedFile key.
3443
- * @function Url
3444
- * @param {string} [url=undefined] - If defined, upload URL is set to specified value.
3445
- * @returns string
3446
- */
3447
- public Url(url?:string):string;
3448
- /**
3449
- * Fit.Controls.ControlBase.Width override:
3450
- Get/set control width - returns object with Value and Unit properties.
3451
- This implementation differs from ControlBase.Width as passing a value of -1 resets
3452
- the control width to fit its content, rather than assuming a fixed default width.
3453
- * @function Width
3454
- * @param {number} [val=undefined] - If defined, control width is updated to specified value. A value of -1 resets control width.
3455
- * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, control width is updated to specified CSS unit.
3456
- * @returns Fit.TypeDefs.CssValue
3457
- */
3458
- public Width(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
3459
- // Functions defined by Fit.Controls.ControlBase
3460
- /**
3461
- * Add CSS class to DOMElement representing control.
3462
- * @function AddCssClass
3463
- * @param {string} val - CSS class to add.
3464
- */
3465
- public AddCssClass(val:string):void;
3466
- /**
3467
- * Set callback function used to perform on-the-fly validation against control.
3468
- * @function AddValidationRule
3469
- * @param {Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>} validator - Function receiving an instance of the control.
3470
- A value of False or a non-empty string with an
3471
- error message must be returned if value is invalid.
3472
- */
3473
- public AddValidationRule(validator:Fit.Controls.ControlBaseTypeDefs.ValidationCallback<this>):void;
3474
- /**
3475
- * Set regular expression used to perform on-the-fly validation against control value, as returned by the Value() function.
3476
- * @function AddValidationRule
3477
- * @param {RegExp} validator - Regular expression to validate value against.
3478
- * @param {string} [errorMessage=undefined] - Optional error message displayed if value validation fails.
3479
- */
3480
- public AddValidationRule(validator:RegExp, errorMessage?:string):void;
3481
- /**
3482
- * Get/set value indicating whether control is always considered dirty. This
3483
- comes in handy when programmatically changing a value of a control on behalf
3484
- of the user. Some applications may choose to only save values from dirty controls.
3485
- * @function AlwaysDirty
3486
- * @param {boolean} [val=undefined] - If defined, Always Dirty is enabled/disabled.
3487
- * @returns boolean
3488
- */
3489
- public AlwaysDirty(val?:boolean):boolean;
3490
- /**
3491
- * Set flag indicating whether control should post back changes automatically when value is changed.
3492
- * @function AutoPostBack
3493
- * @param {boolean} [val=undefined] - If defined, True enables auto post back, False disables it.
3494
- * @returns boolean
3495
- */
3496
- public AutoPostBack(val?:boolean):boolean;
3292
+ public AutoPostBack(val?:boolean):boolean;
3497
3293
  /**
3498
3294
  * Clear control value.
3499
3295
  * @function Clear
@@ -3708,257 +3504,279 @@ declare namespace Fit
3708
3504
  }
3709
3505
  /**
3710
3506
  *
3711
- * @namespace [Fit.Controls.FilePickerTypeDefs FilePickerTypeDefs]
3507
+ * @namespace [Fit.Controls.DropDownTypeDefs DropDownTypeDefs]
3712
3508
  */
3713
- namespace FilePickerTypeDefs
3509
+ namespace DropDownTypeDefs
3714
3510
  {
3715
- // Functions defined by Fit.Controls.FilePickerTypeDefs
3511
+ // Functions defined by Fit.Controls.DropDownTypeDefs
3716
3512
  /**
3717
- * Cancelable upload event handler.
3718
- * @callback CancelableUploadEventHandler
3719
- * @param {Fit.Controls.FilePicker} sender - Instance of FilePicker.
3720
- * @returns boolean | void
3513
+ * Input changed event handler.
3514
+ * @template TypeOfThis
3515
+ * @callback InputChangedEventHandler
3516
+ * @param {TypeOfThis} sender - Instance of control.
3517
+ * @param {string} value - Input value.
3721
3518
  */
3722
- type CancelableUploadEventHandler = (sender:Fit.Controls.FilePicker) => boolean | void;
3519
+ type InputChangedEventHandler<TypeOfThis> = (sender:TypeOfThis, value:string) => void;
3723
3520
  /**
3724
- * Completed event handler.
3725
- * @callback CompletedEventHandler
3726
- * @param {Fit.Controls.FilePicker} sender - Instance of FilePicker.
3521
+ * Event handler.
3522
+ * @template TypeOfThis
3523
+ * @callback InteractionEventHandler
3524
+ * @param {TypeOfThis} sender - Instance of control.
3727
3525
  */
3728
- type CompletedEventHandler = (sender:Fit.Controls.FilePicker) => void;
3526
+ type InteractionEventHandler<TypeOfThis> = (sender:TypeOfThis) => void;
3729
3527
  /**
3730
- * Returns image preview for supported file types, Null for unsupported file types, and Null on browsers not supporting the File API.
3731
- * @callback GetImagePreview
3732
- * @returns HTMLImageElement | null
3528
+ * Paste event handler.
3529
+ * @template TypeOfThis
3530
+ * @callback PasteEventHandler
3531
+ * @param {TypeOfThis} sender - Instance of control.
3532
+ * @param {string} value - Value pasted into input field.
3533
+ * @returns boolean | void
3733
3534
  */
3734
- type GetImagePreview = () => HTMLImageElement | null;
3535
+ type PasteEventHandler<TypeOfThis> = (sender:TypeOfThis, value:string) => boolean | void;
3735
3536
  /**
3736
- * Progress event handler.
3737
- * @callback ProgressEventHandler
3738
- * @param {Fit.Controls.FilePicker} sender - Instance of FilePicker.
3739
- * @param {Fit.Controls.FilePickerTypeDefs.File} eventArgs - Event arguments.
3537
+ * Callback responsible for constructing string value representing selected items.
3538
+ * @template TypeOfThis
3539
+ * @callback SelectionToStringCallback
3540
+ * @param {TypeOfThis} sender - Instance of control.
3541
+ * @returns string
3740
3542
  */
3741
- type ProgressEventHandler = (sender:Fit.Controls.FilePicker, eventArgs:Fit.Controls.FilePickerTypeDefs.File) => void;
3543
+ type SelectionToStringCallback<TypeOfThis> = (sender:TypeOfThis) => string;
3742
3544
  /**
3743
- * File information.
3744
- * @class [Fit.Controls.FilePickerTypeDefs.File File]
3545
+ * DropDown item.
3546
+ * @class [Fit.Controls.DropDownTypeDefs.DropDownItem DropDownItem]
3745
3547
  */
3746
- class File
3548
+ class DropDownItem
3747
3549
  {
3748
- // Properties defined by Fit.Controls.FilePickerTypeDefs.File
3749
- /**
3750
- * File name.
3751
- * @member {string} Filename
3752
- */
3753
- Filename:string;
3550
+ // Properties defined by Fit.Controls.DropDownTypeDefs.DropDownItem
3754
3551
  /**
3755
- * Native JS File object representing file data - returns Null on browsers not supporting the File API.
3756
- * @member {File | null} FileObject
3552
+ * Item title.
3553
+ * @member {string} Title
3757
3554
  */
3758
- FileObject:File | null;
3555
+ Title:string;
3759
3556
  /**
3760
- * Get image preview for supported file types - returns Null on browsers not supporting the File API.
3761
- * @member {Fit.Controls.FilePickerTypeDefs.GetImagePreview} GetImagePreview
3557
+ * Value indicating whether item is a valid selection.
3558
+ * @member {boolean} Valid
3762
3559
  */
3763
- GetImagePreview:Fit.Controls.FilePickerTypeDefs.GetImagePreview;
3560
+ Valid:boolean;
3764
3561
  /**
3765
- * Unique file ID.
3766
- * @member {string} Id
3562
+ * Unique item value.
3563
+ * @member {string} Value
3767
3564
  */
3768
- Id:string;
3565
+ Value:string;
3566
+ }
3567
+ /**
3568
+ * DropDown item.
3569
+ * @class [Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem UpdatedDropDownItem]
3570
+ */
3571
+ class UpdatedDropDownItem
3572
+ {
3573
+ // Properties defined by Fit.Controls.DropDownTypeDefs.UpdatedDropDownItem
3769
3574
  /**
3770
- * Flag indicating whether file has been uploaded, or is currently being uploaded, with a value of True.
3771
- * @member {boolean} Processed
3575
+ * Value indicating whether item still exists or not.
3576
+ * @member {boolean} Exists
3772
3577
  */
3773
- Processed:boolean;
3578
+ Exists:boolean;
3774
3579
  /**
3775
- * Value from 0-100 indicating upload progress, a value of -1 when not uploading/uploaded.
3776
- * @member {number} Progress
3580
+ * Updated item title.
3581
+ * @member {string} Title
3777
3582
  */
3778
- Progress:number;
3583
+ Title:string;
3779
3584
  /**
3780
- * Response from server after successful file upload, otherwise Null.
3781
- * @member {string | null} ServerResponse
3585
+ * unique item value.
3586
+ * @member {string} Value
3782
3587
  */
3783
- ServerResponse:string | null;
3784
- /**
3785
- * File size in bytes - returns -1 on browsers not supporting the File API.
3786
- * @member {number} Size
3787
- */
3788
- Size:number;
3789
- /**
3790
- * Mime type - returns Unknown on browsers not supporting the File API.
3791
- * @member {string} Type
3792
- */
3793
- Type:string;
3588
+ Value:string;
3794
3589
  }
3795
3590
  }
3796
3591
  /**
3797
- * Input control which allows for one or multiple lines of
3798
- text, and features a Design Mode for rich HTML content.
3592
+ * Control allowing for files to be selected locally and uploaded asynchronously.
3799
3593
  Extending from Fit.Controls.ControlBase.
3800
- * @class [Fit.Controls.Input Input]
3594
+ * @class [Fit.Controls.FilePicker FilePicker]
3801
3595
  */
3802
- class Input
3596
+ class FilePicker
3803
3597
  {
3804
- // Functions defined by Fit.Controls.Input
3805
- /**
3806
- * Get/set value indicating whether control should have spell checking enabled (default) or disabled.
3807
- * @function CheckSpelling
3808
- * @param {boolean} [val=undefined] - If defined, true enables spell checking while false disables it.
3809
- * @returns boolean
3810
- */
3811
- public CheckSpelling(val?:boolean):boolean;
3598
+ // Functions defined by Fit.Controls.FilePicker
3812
3599
  /**
3813
- * Get/set value indicating whether control should have spell checking enabled (default) or disabled.
3814
- * @function CheckSpelling
3815
- * @param {boolean} [val=undefined] - If defined, true enables spell checking while false disables it.
3600
+ * Get/set value indicating whether control automatically starts upload process when files are selected.
3601
+ * @function AutoUpload
3602
+ * @param {boolean} [val=undefined] - If specified, True enables auto upload, False disables it (default).
3816
3603
  * @returns boolean
3817
3604
  */
3818
- public CheckSpelling(val?:boolean):boolean;
3819
- /**
3820
- * Get/set number of milliseconds used to postpone onchange event.
3821
- Every new keystroke/change resets the timer. Debouncing can
3822
- improve performance when working with large amounts of data.
3823
- * @function DebounceOnChange
3824
- * @param {number} timeout - If defined, timeout value (milliseconds) is updated - a value of -1 disables debouncing.
3825
- * @returns number
3826
- */
3827
- public DebounceOnChange(timeout:number):number;
3605
+ public AutoUpload(val?:boolean):boolean;
3828
3606
  /**
3829
- * Get/set number of milliseconds used to postpone onchange event.
3830
- Every new keystroke/change resets the timer. Debouncing can
3831
- improve performance when working with large amounts of data.
3832
- * @function DebounceOnChange
3833
- * @param {number} timeout - If defined, timeout value (milliseconds) is updated - a value of -1 disables debouncing.
3834
- * @returns number
3607
+ * Get/set button text.
3608
+ * @function ButtonText
3609
+ * @param {string} [val=undefined] - If defined, button text is set to specified value.
3610
+ * @returns string
3835
3611
  */
3836
- public DebounceOnChange(timeout:number):number;
3612
+ public ButtonText(val?:string):string;
3837
3613
  /**
3838
- * Get/set value indicating whether control is in Design Mode allowing for rich HTML content.
3839
- Notice that this control type requires dimensions (Width/Height) to be specified in pixels.
3840
- * @function DesignMode
3841
- * @param {boolean} [val=undefined] - If defined, True enables Design Mode, False disables it.
3842
- * @param {Fit.Controls.InputTypeDefs.DesignModeConfig} [editorConfig=undefined] - If provided and DesignMode is enabled, configuration is applied when editor is created.
3843
- * @returns boolean
3614
+ * Get/set drop zone text.
3615
+ * @function DropZoneText
3616
+ * @param {string} [val=undefined] - If defined, drop zone text is set to specified value.
3617
+ * @returns string
3844
3618
  */
3845
- public DesignMode(val?:boolean, editorConfig?:Fit.Controls.InputTypeDefs.DesignModeConfig):boolean;
3619
+ public DropZoneText(val?:string):string;
3846
3620
  /**
3847
- * Get/set value indicating whether control is in Design Mode allowing for rich HTML content.
3848
- Notice that this control type requires dimensions (Width/Height) to be specified in pixels.
3849
- * @function DesignMode
3850
- * @param {boolean} [val=undefined] - If defined, True enables Design Mode, False disables it.
3851
- * @param {Fit.Controls.InputTypeDefs.DesignModeConfig} [editorConfig=undefined] - If provided and DesignMode is enabled, configuration is applied when editor is created.
3621
+ * Get/set value indicating whether control is enabled or not.
3622
+ Any files added to the control prior to being disabled, will
3623
+ not be included with a traditional postback to the server.
3624
+ * @function Enabled
3625
+ * @param {boolean} [val=undefined] - If specified, True enables control, False disables it.
3852
3626
  * @returns boolean
3853
3627
  */
3854
- public DesignMode(val?:boolean, editorConfig?:Fit.Controls.InputTypeDefs.DesignModeConfig):boolean;
3855
- /**
3856
- * Create instance of Input control.
3857
- * @function Input
3858
- * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
3859
- */
3860
- constructor(ctlId?:string);
3628
+ public Enabled(val?:boolean):boolean;
3861
3629
  /**
3862
- * Create instance of Input control.
3863
- * @function Input
3630
+ * Create instance of FilePicker control.
3631
+ * @function FilePicker
3864
3632
  * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
3865
3633
  */
3866
3634
  constructor(ctlId?:string);
3867
3635
  /**
3868
- * Get/set value indicating whether control is maximizable.
3869
- Making control maximizable will disable Resizable.
3870
- * @function Maximizable
3871
- * @param {boolean} [val=undefined] - If defined, True enables maximize button, False disables it.
3872
- * @param {number} [heightMax=undefined] - If defined, this becomes the height of the input control when maximized.
3873
- The value is considered the same unit set using Height(..) which defaults to px.
3874
- If not set, the value assumes twice the height set using Height(..).
3875
- * @returns boolean
3636
+ * Get collection of selected files. Each file is represented as an object with the following members:
3637
+ - Filename:string (Name of selected file)
3638
+ - Type:string (Mime type for selected file)
3639
+ - Size:integer (File size in bytes)
3640
+ - Id:string (Unique file ID)
3641
+ - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3642
+ - Progress:integer (Value from 0-100 indicating upload progress, a value of -1 when not uploading/uploaded)
3643
+ - FileObject:File (Native JS File object representing selected file)
3644
+ - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3645
+ - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3646
+ NOTICE: The following properties/functions are not available in Legacy Mode: Type, Size, FileObject, GetImagePreview().
3647
+ * @function GetFiles
3648
+ * @returns Fit.Controls.FilePickerTypeDefs.File[]
3876
3649
  */
3877
- public Maximizable(val?:boolean, heightMax?:number):boolean;
3650
+ public GetFiles():Fit.Controls.FilePickerTypeDefs.File[];
3878
3651
  /**
3879
- * Get/set value indicating whether control is maximizable.
3880
- Making control maximizable will disable Resizable.
3881
- * @function Maximizable
3882
- * @param {boolean} [val=undefined] - If defined, True enables maximize button, False disables it.
3883
- * @param {number} [heightMax=undefined] - If defined, this becomes the height of the input control when maximized.
3884
- The value is considered the same unit set using Height(..) which defaults to px.
3885
- If not set, the value assumes twice the height set using Height(..).
3652
+ * Get value indicating whether control is in legacy mode (old fashion upload control).
3653
+ * @function IsLegacyModeEnabled
3886
3654
  * @returns boolean
3887
3655
  */
3888
- public Maximizable(val?:boolean, heightMax?:number):boolean;
3656
+ public IsLegacyModeEnabled():boolean;
3889
3657
  /**
3890
- * Get/set value indicating whether control is maximized.
3891
- * @function Maximized
3892
- * @param {boolean} [val=undefined] - If defined, True maximizes control, False minimizes it.
3658
+ * Get/set flag indicating whether control allows for multiple selections.
3659
+ * @function MultiSelectionMode
3660
+ * @param {boolean} [val=undefined] - If defined, True enables multi selection mode, False disables it.
3893
3661
  * @returns boolean
3894
3662
  */
3895
- public Maximized(val?:boolean):boolean;
3663
+ public MultiSelectionMode(val?:boolean):boolean;
3896
3664
  /**
3897
- * Get/set value indicating whether control is maximized.
3898
- * @function Maximized
3899
- * @param {boolean} [val=undefined] - If defined, True maximizes control, False minimizes it.
3900
- * @returns boolean
3665
+ * Add event handler fired when all files selected have been fully processed.
3666
+ Be aware that this event fires even if some files were not uploaded successfully.
3667
+ At this point files returned from GetFiles() contains a ServerResponse:string property
3668
+ containing the response from the server. This property remains Null in case of errors.
3669
+ Function receives one argument: Sender (Fit.Controls.FlePicker).
3670
+ * @function OnCompleted
3671
+ * @param {Fit.Controls.FilePickerTypeDefs.CompletedEventHandler} cb - Event handler function.
3901
3672
  */
3902
- public Maximized(val?:boolean):boolean;
3673
+ public OnCompleted(cb:Fit.Controls.FilePickerTypeDefs.CompletedEventHandler):void;
3903
3674
  /**
3904
- * Get/set value indicating whether control is in Multi Line mode (textarea).
3905
- * @function MultiLine
3906
- * @param {boolean} [val=undefined] - If defined, True enables Multi Line mode, False disables it.
3907
- * @returns boolean
3675
+ * Add event handler fired for a given file if the upload process failed.
3676
+ Function receives two arguments:
3677
+ Sender (Fit.Controls.FlePicker) and EventArgs object.
3678
+ EventArgs object contains the following members:
3679
+ - Filename:string (Name of given file)
3680
+ - Type:string (Mime type for given file)
3681
+ - Size:integer (File size in bytes)
3682
+ - Id:string (Unique file ID)
3683
+ - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3684
+ - Progress:integer (A value from 0-100 indicating how many percent of the file has been uploaded)
3685
+ - FileObject:File (Native JS File object representing given file)
3686
+ - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3687
+ - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3688
+ Be aware that Type and Size cannot be determined in Legacy Mode, and that FileObject in this
3689
+ case will be Null. GetImagePreview() will also return Null in Legacy Mode.
3690
+ * @function OnFailure
3691
+ * @param {Fit.Controls.FilePickerTypeDefs.ProgressEventHandler} cb - Event handler function.
3908
3692
  */
3909
- public MultiLine(val?:boolean):boolean;
3693
+ public OnFailure(cb:Fit.Controls.FilePickerTypeDefs.ProgressEventHandler):void;
3910
3694
  /**
3911
- * Get/set value indicating whether control is in Multi Line mode (textarea).
3912
- * @function MultiLine
3913
- * @param {boolean} [val=undefined] - If defined, True enables Multi Line mode, False disables it.
3914
- * @returns boolean
3695
+ * Add event handler fired when the upload process for a given file is progressing.
3696
+ Function receives two arguments:
3697
+ Sender (Fit.Controls.FlePicker) and EventArgs object.
3698
+ EventArgs object contains the following members:
3699
+ - Filename:string (Name of given file)
3700
+ - Type:string (Mime type for given file)
3701
+ - Size:integer (File size in bytes)
3702
+ - Id:string (Unique file ID)
3703
+ - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3704
+ - Progress:integer (A value from 0-100 indicating how many percent of the file has been uploaded)
3705
+ - FileObject:File (Native JS File object representing given file)
3706
+ - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3707
+ - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3708
+ Be aware that Type and Size cannot be determined in Legacy Mode, and that FileObject in this
3709
+ case will be Null. GetImagePreview() will also return Null in Legacy Mode.
3710
+ * @function OnProgress
3711
+ * @param {Fit.Controls.FilePickerTypeDefs.ProgressEventHandler} cb - Event handler function.
3915
3712
  */
3916
- public MultiLine(val?:boolean):boolean;
3713
+ public OnProgress(cb:Fit.Controls.FilePickerTypeDefs.ProgressEventHandler):void;
3917
3714
  /**
3918
- * Get/set value used as a placeholder to indicate expected input on supported browsers.
3919
- * @function Placeholder
3920
- * @param {string} [val=undefined] - If defined, value is set as placeholder.
3921
- * @returns string
3715
+ * Add event handler fired when a file has successfully been uploaded.
3716
+ Function receives two arguments:
3717
+ Sender (Fit.Controls.FlePicker) and EventArgs object.
3718
+ EventArgs object contains the following members:
3719
+ - Filename:string (Name of given file)
3720
+ - Type:string (Mime type for given file)
3721
+ - Size:integer (File size in bytes)
3722
+ - Id:string (Unique file ID)
3723
+ - Processed:boolean (Flag indicating whether file has been uploaded, or is currently being uploaded)
3724
+ - Progress:integer (A value from 0-100 indicating how many percent of the file has been uploaded)
3725
+ - FileObject:File (Native JS File object representing given file)
3726
+ - GetImagePreview:function (Returns an HTMLImageElement with a preview for supported file types)
3727
+ - ServerResponse:string (Response from server after successful file upload, otherwise Null)
3728
+ Be aware that Type and Size cannot be determined in Legacy Mode, and that FileObject in this
3729
+ case will be Null. GetImagePreview() will also return Null in Legacy Mode.
3730
+ * @function OnSuccess
3731
+ * @param {Fit.Controls.FilePickerTypeDefs.ProgressEventHandler} cb - Event handler function.
3922
3732
  */
3923
- public Placeholder(val?:string):string;
3733
+ public OnSuccess(cb:Fit.Controls.FilePickerTypeDefs.ProgressEventHandler):void;
3924
3734
  /**
3925
- * Get/set value used as a placeholder to indicate expected input on supported browsers.
3926
- * @function Placeholder
3927
- * @param {string} [val=undefined] - If defined, value is set as placeholder.
3928
- * @returns string
3735
+ * Add event handler fired when upload is started.
3736
+ Operation can be canceled by returning False.
3737
+ Function receives one argument: Sender (Fit.Controls.FilePicker).
3738
+ * @function OnUpload
3739
+ * @param {Fit.Controls.FilePickerTypeDefs.CancelableUploadEventHandler} cb - Event handler function.
3929
3740
  */
3930
- public Placeholder(val?:string):string;
3741
+ public OnUpload(cb:Fit.Controls.FilePickerTypeDefs.CancelableUploadEventHandler):void;
3931
3742
  /**
3932
- * Get/set value indicating whether control is resizable on supported
3933
- (modern) browsers. Making control resizable will disable Maximizable.
3934
- * @function Resizable
3935
- * @param {Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"} [val=undefined] - If defined, determines whether control resizes, and in what direction(s).
3936
- * @returns Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"
3743
+ * Get/set value indicating whether control is displayed as a drop zone on supported browsers or not.
3744
+ * @function ShowDropZone
3745
+ * @param {boolean} [val=undefined] - If specified, True enables drop zone, False disables it (default).
3746
+ * @returns boolean
3937
3747
  */
3938
- public Resizable(val?:Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"):Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical";
3748
+ public ShowDropZone(val?:boolean):boolean;
3939
3749
  /**
3940
- * Get/set value indicating whether control is resizable on supported
3941
- (modern) browsers. Making control resizable will disable Maximizable.
3942
- * @function Resizable
3943
- * @param {Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"} [val=undefined] - If defined, determines whether control resizes, and in what direction(s).
3944
- * @returns Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"
3750
+ * Upload selected files. Each file will be uploaded using POST over individual HTTP connections,
3751
+ and each file will be accessible from the POST data collection using the SelectedFile key.
3752
+ Use the OnProgress event to monitor the upload process, or use the OnCompleted event
3753
+ to be notified when all files have been fully processed.
3754
+ * @function Upload
3755
+ * @param {string[]} [skip=undefined] - Optional argument allowing some of the selected files to be skipped during
3756
+ upload. The argument is a string array with the names of the files to skip.
3945
3757
  */
3946
- public Resizable(val?:Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"):Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical";
3758
+ public Upload(skip?:string[]):void;
3947
3759
  /**
3948
- * Get/set input type (e.g. Text, Password, Email, etc.).
3949
- * @function Type
3950
- * @param {Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"} [val=undefined] - If defined, input type is changed to specified value.
3951
- * @returns Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"
3760
+ * Get/set URL to which files are uploaded when FilePicker.Upload() is called.
3761
+ Multiple files will be uploaded using POST over individual HTTP connections,
3762
+ and each file will be accessible from the POST data collection using the SelectedFile key.
3763
+ * @function Url
3764
+ * @param {string} [url=undefined] - If defined, upload URL is set to specified value.
3765
+ * @returns string
3952
3766
  */
3953
- public Type(val?:Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"):Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week";
3767
+ public Url(url?:string):string;
3954
3768
  /**
3955
- * Get/set input type (e.g. Text, Password, Email, etc.).
3956
- * @function Type
3957
- * @param {Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"} [val=undefined] - If defined, input type is changed to specified value.
3958
- * @returns Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"
3959
- */
3960
- public Type(val?:Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"):Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week";
3961
- // Functions defined by Fit.Controls.ControlBase
3769
+ * Fit.Controls.ControlBase.Width override:
3770
+ Get/set control width - returns object with Value and Unit properties.
3771
+ This implementation differs from ControlBase.Width as passing a value of -1 resets
3772
+ the control width to fit its content, rather than assuming a fixed default width.
3773
+ * @function Width
3774
+ * @param {number} [val=undefined] - If defined, control width is updated to specified value. A value of -1 resets control width.
3775
+ * @param {Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"} [unit=px] - If defined, control width is updated to specified CSS unit.
3776
+ * @returns Fit.TypeDefs.CssValue
3777
+ */
3778
+ public Width(val?:number, unit?:Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw"):Fit.TypeDefs.CssValue;
3779
+ // Functions defined by Fit.Controls.ControlBase
3962
3780
  /**
3963
3781
  * Add CSS class to DOMElement representing control.
3964
3782
  * @function AddCssClass
@@ -4209,6 +4027,93 @@ declare namespace Fit
4209
4027
  public Render(toElement?:HTMLElement):void;
4210
4028
  }
4211
4029
  /**
4030
+ *
4031
+ * @namespace [Fit.Controls.FilePickerTypeDefs FilePickerTypeDefs]
4032
+ */
4033
+ namespace FilePickerTypeDefs
4034
+ {
4035
+ // Functions defined by Fit.Controls.FilePickerTypeDefs
4036
+ /**
4037
+ * Cancelable upload event handler.
4038
+ * @callback CancelableUploadEventHandler
4039
+ * @param {Fit.Controls.FilePicker} sender - Instance of FilePicker.
4040
+ * @returns boolean | void
4041
+ */
4042
+ type CancelableUploadEventHandler = (sender:Fit.Controls.FilePicker) => boolean | void;
4043
+ /**
4044
+ * Completed event handler.
4045
+ * @callback CompletedEventHandler
4046
+ * @param {Fit.Controls.FilePicker} sender - Instance of FilePicker.
4047
+ */
4048
+ type CompletedEventHandler = (sender:Fit.Controls.FilePicker) => void;
4049
+ /**
4050
+ * Returns image preview for supported file types, Null for unsupported file types, and Null on browsers not supporting the File API.
4051
+ * @callback GetImagePreview
4052
+ * @returns HTMLImageElement | null
4053
+ */
4054
+ type GetImagePreview = () => HTMLImageElement | null;
4055
+ /**
4056
+ * Progress event handler.
4057
+ * @callback ProgressEventHandler
4058
+ * @param {Fit.Controls.FilePicker} sender - Instance of FilePicker.
4059
+ * @param {Fit.Controls.FilePickerTypeDefs.File} eventArgs - Event arguments.
4060
+ */
4061
+ type ProgressEventHandler = (sender:Fit.Controls.FilePicker, eventArgs:Fit.Controls.FilePickerTypeDefs.File) => void;
4062
+ /**
4063
+ * File information.
4064
+ * @class [Fit.Controls.FilePickerTypeDefs.File File]
4065
+ */
4066
+ class File
4067
+ {
4068
+ // Properties defined by Fit.Controls.FilePickerTypeDefs.File
4069
+ /**
4070
+ * File name.
4071
+ * @member {string} Filename
4072
+ */
4073
+ Filename:string;
4074
+ /**
4075
+ * Native JS File object representing file data - returns Null on browsers not supporting the File API.
4076
+ * @member {File | null} FileObject
4077
+ */
4078
+ FileObject:File | null;
4079
+ /**
4080
+ * Get image preview for supported file types - returns Null on browsers not supporting the File API.
4081
+ * @member {Fit.Controls.FilePickerTypeDefs.GetImagePreview} GetImagePreview
4082
+ */
4083
+ GetImagePreview:Fit.Controls.FilePickerTypeDefs.GetImagePreview;
4084
+ /**
4085
+ * Unique file ID.
4086
+ * @member {string} Id
4087
+ */
4088
+ Id:string;
4089
+ /**
4090
+ * Flag indicating whether file has been uploaded, or is currently being uploaded, with a value of True.
4091
+ * @member {boolean} Processed
4092
+ */
4093
+ Processed:boolean;
4094
+ /**
4095
+ * Value from 0-100 indicating upload progress, a value of -1 when not uploading/uploaded.
4096
+ * @member {number} Progress
4097
+ */
4098
+ Progress:number;
4099
+ /**
4100
+ * Response from server after successful file upload, otherwise Null.
4101
+ * @member {string | null} ServerResponse
4102
+ */
4103
+ ServerResponse:string | null;
4104
+ /**
4105
+ * File size in bytes - returns -1 on browsers not supporting the File API.
4106
+ * @member {number} Size
4107
+ */
4108
+ Size:number;
4109
+ /**
4110
+ * Mime type - returns Unknown on browsers not supporting the File API.
4111
+ * @member {string} Type
4112
+ */
4113
+ Type:string;
4114
+ }
4115
+ }
4116
+ /**
4212
4117
  * Input control which allows for one or multiple lines of
4213
4118
  text, and features a Design Mode for rich HTML content.
4214
4119
  Extending from Fit.Controls.ControlBase.
@@ -4225,22 +4130,6 @@ declare namespace Fit
4225
4130
  */
4226
4131
  public CheckSpelling(val?:boolean):boolean;
4227
4132
  /**
4228
- * Get/set value indicating whether control should have spell checking enabled (default) or disabled.
4229
- * @function CheckSpelling
4230
- * @param {boolean} [val=undefined] - If defined, true enables spell checking while false disables it.
4231
- * @returns boolean
4232
- */
4233
- public CheckSpelling(val?:boolean):boolean;
4234
- /**
4235
- * Get/set number of milliseconds used to postpone onchange event.
4236
- Every new keystroke/change resets the timer. Debouncing can
4237
- improve performance when working with large amounts of data.
4238
- * @function DebounceOnChange
4239
- * @param {number} timeout - If defined, timeout value (milliseconds) is updated - a value of -1 disables debouncing.
4240
- * @returns number
4241
- */
4242
- public DebounceOnChange(timeout:number):number;
4243
- /**
4244
4133
  * Get/set number of milliseconds used to postpone onchange event.
4245
4134
  Every new keystroke/change resets the timer. Debouncing can
4246
4135
  improve performance when working with large amounts of data.
@@ -4259,21 +4148,6 @@ declare namespace Fit
4259
4148
  */
4260
4149
  public DesignMode(val?:boolean, editorConfig?:Fit.Controls.InputTypeDefs.DesignModeConfig):boolean;
4261
4150
  /**
4262
- * Get/set value indicating whether control is in Design Mode allowing for rich HTML content.
4263
- Notice that this control type requires dimensions (Width/Height) to be specified in pixels.
4264
- * @function DesignMode
4265
- * @param {boolean} [val=undefined] - If defined, True enables Design Mode, False disables it.
4266
- * @param {Fit.Controls.InputTypeDefs.DesignModeConfig} [editorConfig=undefined] - If provided and DesignMode is enabled, configuration is applied when editor is created.
4267
- * @returns boolean
4268
- */
4269
- public DesignMode(val?:boolean, editorConfig?:Fit.Controls.InputTypeDefs.DesignModeConfig):boolean;
4270
- /**
4271
- * Create instance of Input control.
4272
- * @function Input
4273
- * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
4274
- */
4275
- constructor(ctlId?:string);
4276
- /**
4277
4151
  * Create instance of Input control.
4278
4152
  * @function Input
4279
4153
  * @param {string} [ctlId=undefined] - Unique control ID that can be used to access control using Fit.Controls.Find(..).
@@ -4291,24 +4165,6 @@ declare namespace Fit
4291
4165
  */
4292
4166
  public Maximizable(val?:boolean, heightMax?:number):boolean;
4293
4167
  /**
4294
- * Get/set value indicating whether control is maximizable.
4295
- Making control maximizable will disable Resizable.
4296
- * @function Maximizable
4297
- * @param {boolean} [val=undefined] - If defined, True enables maximize button, False disables it.
4298
- * @param {number} [heightMax=undefined] - If defined, this becomes the height of the input control when maximized.
4299
- The value is considered the same unit set using Height(..) which defaults to px.
4300
- If not set, the value assumes twice the height set using Height(..).
4301
- * @returns boolean
4302
- */
4303
- public Maximizable(val?:boolean, heightMax?:number):boolean;
4304
- /**
4305
- * Get/set value indicating whether control is maximized.
4306
- * @function Maximized
4307
- * @param {boolean} [val=undefined] - If defined, True maximizes control, False minimizes it.
4308
- * @returns boolean
4309
- */
4310
- public Maximized(val?:boolean):boolean;
4311
- /**
4312
4168
  * Get/set value indicating whether control is maximized.
4313
4169
  * @function Maximized
4314
4170
  * @param {boolean} [val=undefined] - If defined, True maximizes control, False minimizes it.
@@ -4323,20 +4179,6 @@ declare namespace Fit
4323
4179
  */
4324
4180
  public MultiLine(val?:boolean):boolean;
4325
4181
  /**
4326
- * Get/set value indicating whether control is in Multi Line mode (textarea).
4327
- * @function MultiLine
4328
- * @param {boolean} [val=undefined] - If defined, True enables Multi Line mode, False disables it.
4329
- * @returns boolean
4330
- */
4331
- public MultiLine(val?:boolean):boolean;
4332
- /**
4333
- * Get/set value used as a placeholder to indicate expected input on supported browsers.
4334
- * @function Placeholder
4335
- * @param {string} [val=undefined] - If defined, value is set as placeholder.
4336
- * @returns string
4337
- */
4338
- public Placeholder(val?:string):string;
4339
- /**
4340
4182
  * Get/set value used as a placeholder to indicate expected input on supported browsers.
4341
4183
  * @function Placeholder
4342
4184
  * @param {string} [val=undefined] - If defined, value is set as placeholder.
@@ -4347,32 +4189,17 @@ declare namespace Fit
4347
4189
  * Get/set value indicating whether control is resizable on supported
4348
4190
  (modern) browsers. Making control resizable will disable Maximizable.
4349
4191
  * @function Resizable
4350
- * @param {Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"} [val=undefined] - If defined, determines whether control resizes, and in what direction(s).
4351
- * @returns Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"
4352
- */
4353
- public Resizable(val?:Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"):Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical";
4354
- /**
4355
- * Get/set value indicating whether control is resizable on supported
4356
- (modern) browsers. Making control resizable will disable Maximizable.
4357
- * @function Resizable
4358
- * @param {Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"} [val=undefined] - If defined, determines whether control resizes, and in what direction(s).
4359
- * @returns Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"
4360
- */
4361
- public Resizable(val?:Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical"):Fit.Controls.InputResizing | "Disabled" | "Disabled" | "Enabled" | "Enabled" | "Horizontal" | "Horizontal" | "Vertical" | "Vertical";
4362
- /**
4363
- * Get/set input type (e.g. Text, Password, Email, etc.).
4364
- * @function Type
4365
- * @param {Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"} [val=undefined] - If defined, input type is changed to specified value.
4366
- * @returns Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"
4192
+ * @param {Fit.Controls.InputResizing | "Disabled" | "Enabled" | "Horizontal" | "Vertical"} [val=undefined] - If defined, determines whether control resizes, and in what direction(s).
4193
+ * @returns Fit.Controls.InputResizing | "Disabled" | "Enabled" | "Horizontal" | "Vertical"
4367
4194
  */
4368
- public Type(val?:Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"):Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week";
4195
+ public Resizable(val?:Fit.Controls.InputResizing | "Disabled" | "Enabled" | "Horizontal" | "Vertical"):Fit.Controls.InputResizing | "Disabled" | "Enabled" | "Horizontal" | "Vertical";
4369
4196
  /**
4370
4197
  * Get/set input type (e.g. Text, Password, Email, etc.).
4371
4198
  * @function Type
4372
- * @param {Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"} [val=undefined] - If defined, input type is changed to specified value.
4373
- * @returns Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"
4199
+ * @param {Fit.Controls.InputType | "Color" | "Date" | "DateTime" | "Email" | "Month" | "Number" | "Password" | "PhoneNumber" | "Text" | "Textarea" | "Time" | "Week"} [val=undefined] - If defined, input type is changed to specified value.
4200
+ * @returns Fit.Controls.InputType | "Color" | "Date" | "DateTime" | "Email" | "Month" | "Number" | "Password" | "PhoneNumber" | "Text" | "Textarea" | "Time" | "Week"
4374
4201
  */
4375
- public Type(val?:Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week"):Fit.Controls.InputType | "Color" | "Color" | "Date" | "Date" | "DateTime" | "DateTime" | "Email" | "Email" | "Month" | "Month" | "Number" | "Number" | "Password" | "Password" | "PhoneNumber" | "PhoneNumber" | "Text" | "Text" | "Textarea" | "Textarea" | "Time" | "Time" | "Week" | "Week";
4202
+ public Type(val?:Fit.Controls.InputType | "Color" | "Date" | "DateTime" | "Email" | "Month" | "Number" | "Password" | "PhoneNumber" | "Text" | "Textarea" | "Time" | "Week"):Fit.Controls.InputType | "Color" | "Date" | "DateTime" | "Email" | "Month" | "Number" | "Password" | "PhoneNumber" | "Text" | "Textarea" | "Time" | "Week";
4376
4203
  // Functions defined by Fit.Controls.ControlBase
4377
4204
  /**
4378
4205
  * Add CSS class to DOMElement representing control.
@@ -4639,21 +4466,6 @@ declare namespace Fit
4639
4466
  */
4640
4467
  type DesignModeTagsOnRequest = (sender:Fit.Controls.Input, eventArgs:Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs) => boolean | void;
4641
4468
  /**
4642
- * Cancelable request event handler.
4643
- * @callback DesignModeTagsOnRequest
4644
- * @param {Fit.Controls.Input} sender - Instance of control.
4645
- * @param {Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs} eventArgs - Event arguments.
4646
- * @returns boolean | void
4647
- */
4648
- type DesignModeTagsOnRequest = (sender:Fit.Controls.Input, eventArgs:Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs) => boolean | void;
4649
- /**
4650
- * Response event handler.
4651
- * @callback DesignModeTagsOnResponse
4652
- * @param {Fit.Controls.Input} sender - Instance of control.
4653
- * @param {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs} eventArgs - Event arguments.
4654
- */
4655
- type DesignModeTagsOnResponse = (sender:Fit.Controls.Input, eventArgs:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs) => void;
4656
- /**
4657
4469
  * Response event handler.
4658
4470
  * @callback DesignModeTagsOnResponse
4659
4471
  * @param {Fit.Controls.Input} sender - Instance of control.
@@ -4670,63 +4482,6 @@ declare namespace Fit
4670
4482
  */
4671
4483
  type DesignModeTagsTagCreator = (sender:Fit.Controls.Input, eventArgs:Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs) => Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorReturnType | null | void;
4672
4484
  /**
4673
- * Function producing JSON object representing tag to be inserted into editor.
4674
- Returning nothing or Null results in default tag being inserted into editor.
4675
- * @callback DesignModeTagsTagCreator
4676
- * @param {Fit.Controls.Input} sender - Instance of control.
4677
- * @param {Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs} eventArgs - Event arguments.
4678
- * @returns Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorReturnType | null | void
4679
- */
4680
- type DesignModeTagsTagCreator = (sender:Fit.Controls.Input, eventArgs:Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs) => Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorReturnType | null | void;
4681
- /**
4682
- * Auto grow configuration.
4683
- * @class [Fit.Controls.InputTypeDefs.DesignModeAutoGrow DesignModeAutoGrow]
4684
- */
4685
- class DesignModeAutoGrow
4686
- {
4687
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeAutoGrow
4688
- /**
4689
- * Flag indicating whether auto grow feature is enabled or not - on by default if no height is set, or if Height(-1) is set.
4690
- * @member {boolean} Enabled
4691
- */
4692
- Enabled:boolean;
4693
- /**
4694
- * Flag indicating whether auto grow feature is enabled or not - on by default if no height is set, or if Height(-1) is set.
4695
- * @member {boolean} Enabled
4696
- */
4697
- Enabled:boolean;
4698
- /**
4699
- * Maximum height of editable area.
4700
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
4701
- */
4702
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4703
- /**
4704
- * Maximum height of editable area.
4705
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
4706
- */
4707
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4708
- /**
4709
- * Minimum height of editable area.
4710
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
4711
- */
4712
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4713
- /**
4714
- * Minimum height of editable area.
4715
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
4716
- */
4717
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4718
- /**
4719
- * Prevent user from resizing editor beyond maximum height (see MaximumHeight property - defaults to False).
4720
- * @member {boolean} [PreventResizeBeyondMaximumHeight=undefined]
4721
- */
4722
- PreventResizeBeyondMaximumHeight?:boolean;
4723
- /**
4724
- * Prevent user from resizing editor beyond maximum height (see MaximumHeight property - defaults to False).
4725
- * @member {boolean} [PreventResizeBeyondMaximumHeight=undefined]
4726
- */
4727
- PreventResizeBeyondMaximumHeight?:boolean;
4728
- }
4729
- /**
4730
4485
  * Auto grow configuration.
4731
4486
  * @class [Fit.Controls.InputTypeDefs.DesignModeAutoGrow DesignModeAutoGrow]
4732
4487
  */
@@ -4737,1770 +4492,447 @@ declare namespace Fit
4737
4492
  * Flag indicating whether auto grow feature is enabled or not - on by default if no height is set, or if Height(-1) is set.
4738
4493
  * @member {boolean} Enabled
4739
4494
  */
4740
- Enabled:boolean;
4741
- /**
4742
- * Flag indicating whether auto grow feature is enabled or not - on by default if no height is set, or if Height(-1) is set.
4743
- * @member {boolean} Enabled
4744
- */
4745
- Enabled:boolean;
4746
- /**
4747
- * Maximum height of editable area.
4748
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
4749
- */
4750
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4751
- /**
4752
- * Maximum height of editable area.
4753
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
4754
- */
4755
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4756
- /**
4757
- * Minimum height of editable area.
4758
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
4759
- */
4760
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4761
- /**
4762
- * Minimum height of editable area.
4763
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
4764
- */
4765
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
4766
- /**
4767
- * Prevent user from resizing editor beyond maximum height (see MaximumHeight property - defaults to False).
4768
- * @member {boolean} [PreventResizeBeyondMaximumHeight=undefined]
4769
- */
4770
- PreventResizeBeyondMaximumHeight?:boolean;
4771
- /**
4772
- * Prevent user from resizing editor beyond maximum height (see MaximumHeight property - defaults to False).
4773
- * @member {boolean} [PreventResizeBeyondMaximumHeight=undefined]
4774
- */
4775
- PreventResizeBeyondMaximumHeight?:boolean;
4776
- }
4777
- /**
4778
- * Configuration for DesignMode.
4779
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfig DesignModeConfig]
4780
- */
4781
- class DesignModeConfig
4782
- {
4783
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfig
4784
- /**
4785
- * Auto grow configuration.
4786
- * @member {Fit.Controls.InputTypeDefs.DesignModeAutoGrow} [AutoGrow=undefined]
4787
- */
4788
- AutoGrow?:Fit.Controls.InputTypeDefs.DesignModeAutoGrow;
4789
- /**
4790
- * Auto grow configuration.
4791
- * @member {Fit.Controls.InputTypeDefs.DesignModeAutoGrow} [AutoGrow=undefined]
4792
- */
4793
- AutoGrow?:Fit.Controls.InputTypeDefs.DesignModeAutoGrow;
4794
- /**
4795
- * Detachable configuration.
4796
- * @member {Fit.Controls.InputTypeDefs.DesignModeDetachable} [Detachable=undefined]
4797
- */
4798
- Detachable?:Fit.Controls.InputTypeDefs.DesignModeDetachable;
4799
- /**
4800
- * Detachable configuration.
4801
- * @member {Fit.Controls.InputTypeDefs.DesignModeDetachable} [Detachable=undefined]
4802
- */
4803
- Detachable?:Fit.Controls.InputTypeDefs.DesignModeDetachable;
4804
- /**
4805
- * If set, control opens in dialog when activated (on click, on touch, and on ENTER key).
4806
- Control is initially rendered as a read-only value which becomes editable on activation.
4807
- * @member {Fit.Controls.InputTypeDefs.DesignModeDialogMode} [DialogMode=undefined]
4808
- */
4809
- DialogMode?:Fit.Controls.InputTypeDefs.DesignModeDialogMode;
4810
- /**
4811
- * Information panel configuration.
4812
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel} [InfoPanel=undefined]
4813
- */
4814
- InfoPanel?:Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel;
4815
- /**
4816
- * Information panel configuration.
4817
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel} [InfoPanel=undefined]
4818
- */
4819
- InfoPanel?:Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel;
4820
- /**
4821
- * Plugins configuration.
4822
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPlugins} [Plugins=undefined]
4823
- */
4824
- Plugins?:Fit.Controls.InputTypeDefs.DesignModeConfigPlugins;
4825
- /**
4826
- * Plugins configuration.
4827
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPlugins} [Plugins=undefined]
4828
- */
4829
- Plugins?:Fit.Controls.InputTypeDefs.DesignModeConfigPlugins;
4830
- /**
4831
- * Tags configuration.
4832
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigTags} [Tags=undefined]
4833
- */
4834
- Tags?:Fit.Controls.InputTypeDefs.DesignModeConfigTags;
4835
- /**
4836
- * Tags configuration.
4837
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigTags} [Tags=undefined]
4838
- */
4839
- Tags?:Fit.Controls.InputTypeDefs.DesignModeConfigTags;
4840
- /**
4841
- * Toolbar configuration.
4842
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigToolbar} [Toolbar=undefined]
4843
- */
4844
- Toolbar?:Fit.Controls.InputTypeDefs.DesignModeConfigToolbar;
4845
- /**
4846
- * Toolbar configuration.
4847
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigToolbar} [Toolbar=undefined]
4848
- */
4849
- Toolbar?:Fit.Controls.InputTypeDefs.DesignModeConfigToolbar;
4850
- }
4851
- /**
4852
- * Configuration for DesignMode.
4853
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfig DesignModeConfig]
4854
- */
4855
- class DesignModeConfig
4856
- {
4857
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfig
4858
- /**
4859
- * Auto grow configuration.
4860
- * @member {Fit.Controls.InputTypeDefs.DesignModeAutoGrow} [AutoGrow=undefined]
4861
- */
4862
- AutoGrow?:Fit.Controls.InputTypeDefs.DesignModeAutoGrow;
4863
- /**
4864
- * Auto grow configuration.
4865
- * @member {Fit.Controls.InputTypeDefs.DesignModeAutoGrow} [AutoGrow=undefined]
4866
- */
4867
- AutoGrow?:Fit.Controls.InputTypeDefs.DesignModeAutoGrow;
4868
- /**
4869
- * Detachable configuration.
4870
- * @member {Fit.Controls.InputTypeDefs.DesignModeDetachable} [Detachable=undefined]
4871
- */
4872
- Detachable?:Fit.Controls.InputTypeDefs.DesignModeDetachable;
4873
- /**
4874
- * Detachable configuration.
4875
- * @member {Fit.Controls.InputTypeDefs.DesignModeDetachable} [Detachable=undefined]
4876
- */
4877
- Detachable?:Fit.Controls.InputTypeDefs.DesignModeDetachable;
4878
- /**
4879
- * If set, control opens in dialog when activated (on click, on touch, and on ENTER key).
4880
- Control is initially rendered as a read-only value which becomes editable on activation.
4881
- * @member {Fit.Controls.InputTypeDefs.DesignModeDialogMode} [DialogMode=undefined]
4882
- */
4883
- DialogMode?:Fit.Controls.InputTypeDefs.DesignModeDialogMode;
4884
- /**
4885
- * Information panel configuration.
4886
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel} [InfoPanel=undefined]
4887
- */
4888
- InfoPanel?:Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel;
4889
- /**
4890
- * Information panel configuration.
4891
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel} [InfoPanel=undefined]
4892
- */
4893
- InfoPanel?:Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel;
4894
- /**
4895
- * Plugins configuration.
4896
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPlugins} [Plugins=undefined]
4897
- */
4898
- Plugins?:Fit.Controls.InputTypeDefs.DesignModeConfigPlugins;
4899
- /**
4900
- * Plugins configuration.
4901
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPlugins} [Plugins=undefined]
4902
- */
4903
- Plugins?:Fit.Controls.InputTypeDefs.DesignModeConfigPlugins;
4904
- /**
4905
- * Tags configuration.
4906
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigTags} [Tags=undefined]
4907
- */
4908
- Tags?:Fit.Controls.InputTypeDefs.DesignModeConfigTags;
4909
- /**
4910
- * Tags configuration.
4911
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigTags} [Tags=undefined]
4912
- */
4913
- Tags?:Fit.Controls.InputTypeDefs.DesignModeConfigTags;
4914
- /**
4915
- * Toolbar configuration.
4916
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigToolbar} [Toolbar=undefined]
4917
- */
4918
- Toolbar?:Fit.Controls.InputTypeDefs.DesignModeConfigToolbar;
4919
- /**
4920
- * Toolbar configuration.
4921
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigToolbar} [Toolbar=undefined]
4922
- */
4923
- Toolbar?:Fit.Controls.InputTypeDefs.DesignModeConfigToolbar;
4924
- }
4925
- /**
4926
- * Information panel at the top or bottom of the editor, depending on the location of the toolbar.
4927
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel DesignModeConfigInfoPanel]
4928
- */
4929
- class DesignModeConfigInfoPanel
4930
- {
4931
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel
4932
- /**
4933
- * Text alignment - defaults to Center.
4934
- * @member {'Left' | 'Center' | 'Right'} [Alignment=undefined]
4935
- */
4936
- Alignment?:'Left' | 'Center' | 'Right';
4937
- /**
4938
- * Text alignment - defaults to Center.
4939
- * @member {'Left' | 'Center' | 'Right'} [Alignment=undefined]
4940
- */
4941
- Alignment?:'Left' | 'Center' | 'Right';
4942
- /**
4943
- * Text to display.
4944
- * @member {string} [Text=undefined]
4945
- */
4946
- Text?:string;
4947
- /**
4948
- * Text to display.
4949
- * @member {string} [Text=undefined]
4950
- */
4951
- Text?:string;
4952
- }
4953
- /**
4954
- * Information panel at the top or bottom of the editor, depending on the location of the toolbar.
4955
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel DesignModeConfigInfoPanel]
4956
- */
4957
- class DesignModeConfigInfoPanel
4958
- {
4959
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel
4960
- /**
4961
- * Text alignment - defaults to Center.
4962
- * @member {'Left' | 'Center' | 'Right'} [Alignment=undefined]
4963
- */
4964
- Alignment?:'Left' | 'Center' | 'Right';
4965
- /**
4966
- * Text alignment - defaults to Center.
4967
- * @member {'Left' | 'Center' | 'Right'} [Alignment=undefined]
4968
- */
4969
- Alignment?:'Left' | 'Center' | 'Right';
4970
- /**
4971
- * Text to display.
4972
- * @member {string} [Text=undefined]
4973
- */
4974
- Text?:string;
4975
- /**
4976
- * Text to display.
4977
- * @member {string} [Text=undefined]
4978
- */
4979
- Text?:string;
4980
- }
4981
- /**
4982
- * Additional plugins enabled in DesignMode.
4983
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigPlugins DesignModeConfigPlugins]
4984
- */
4985
- class DesignModeConfigPlugins
4986
- {
4987
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigPlugins
4988
- /**
4989
- * Plugin(s) related to emoji support (defaults to False).
4990
- * @member {boolean} [Emojis=undefined]
4991
- */
4992
- Emojis?:boolean;
4993
- /**
4994
- * Plugin(s) related to emoji support (defaults to False).
4995
- * @member {boolean} [Emojis=undefined]
4996
- */
4997
- Emojis?:boolean;
4998
- /**
4999
- * Plugin(s) related to support for images (defaults to False).
5000
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig} [Images=undefined]
5001
- */
5002
- Images?:Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig;
5003
- /**
5004
- * Plugin(s) related to support for images (defaults to False).
5005
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig} [Images=undefined]
5006
- */
5007
- Images?:Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig;
5008
- }
5009
- /**
5010
- * Additional plugins enabled in DesignMode.
5011
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigPlugins DesignModeConfigPlugins]
5012
- */
5013
- class DesignModeConfigPlugins
5014
- {
5015
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigPlugins
5016
- /**
5017
- * Plugin(s) related to emoji support (defaults to False).
5018
- * @member {boolean} [Emojis=undefined]
5019
- */
5020
- Emojis?:boolean;
5021
- /**
5022
- * Plugin(s) related to emoji support (defaults to False).
5023
- * @member {boolean} [Emojis=undefined]
5024
- */
5025
- Emojis?:boolean;
5026
- /**
5027
- * Plugin(s) related to support for images (defaults to False).
5028
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig} [Images=undefined]
5029
- */
5030
- Images?:Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig;
5031
- /**
5032
- * Plugin(s) related to support for images (defaults to False).
5033
- * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig} [Images=undefined]
5034
- */
5035
- Images?:Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig;
5036
- }
5037
- /**
5038
- * Configuration for image plugins.
5039
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig DesignModeConfigPluginsImagesConfig]
5040
- */
5041
- class DesignModeConfigPluginsImagesConfig
5042
- {
5043
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig
5044
- /**
5045
- * How to store and embed images. Base64 (default) is persistent while blob is temporary
5046
- and must be extracted from memory and uploaded/stored to be permanantly persisted.
5047
- References to blobs can be parsed from the HTML value produced by the editor.
5048
- * @member {'base64' | 'blob'} [EmbedType=undefined]
5049
- */
5050
- EmbedType?:'base64' | 'blob';
5051
- /**
5052
- * How to store and embed images. Base64 (default) is persistent while blob is temporary
5053
- and must be extracted from memory and uploaded/stored to be permanantly persisted.
5054
- References to blobs can be parsed from the HTML value produced by the editor.
5055
- * @member {'base64' | 'blob'} [EmbedType=undefined]
5056
- */
5057
- EmbedType?:'base64' | 'blob';
5058
- /**
5059
- * Flag indicating whether to enable image plugins or not (defaults to False).
5060
- * @member {boolean} Enabled
5061
- */
5062
- Enabled:boolean;
5063
- /**
5064
- * Flag indicating whether to enable image plugins or not (defaults to False).
5065
- * @member {boolean} Enabled
5066
- */
5067
- Enabled:boolean;
5068
- /**
5069
- * This option is in effect when EmbedType is blob.
5070
- Dispose images from blob storage (revoke blob URLs) added though image plugins when control is disposed.
5071
- If "UnreferencedOnly" is specified, the component using Fit.UI's input control will be responsible for
5072
- disposing referenced blobs. Failing to do so may cause a memory leak. Defaults to All.
5073
- * @member {'All' | 'UnreferencedOnly'} [RevokeBlobUrlsOnDispose=undefined]
5074
- */
5075
- RevokeBlobUrlsOnDispose?:'All' | 'UnreferencedOnly';
5076
- /**
5077
- * This option is in effect when EmbedType is blob.
5078
- Dispose images from blob storage (revoke blob URLs) added though image plugins when control is disposed.
5079
- If "UnreferencedOnly" is specified, the component using Fit.UI's input control will be responsible for
5080
- disposing referenced blobs. Failing to do so may cause a memory leak. Defaults to All.
5081
- * @member {'All' | 'UnreferencedOnly'} [RevokeBlobUrlsOnDispose=undefined]
5082
- */
5083
- RevokeBlobUrlsOnDispose?:'All' | 'UnreferencedOnly';
5084
- /**
5085
- * This option is in effect when EmbedType is blob.
5086
- Dispose images from blob storage (revoke blob URLs) added through Value(..)
5087
- function when control is disposed. Basically ownership of these blobs are handed
5088
- over to the control for the duration of its life time.
5089
- These images are furthermore subject to the rule set in RevokeBlobUrlsOnDispose.
5090
- Defaults to False.
5091
- * @member {boolean} [RevokeExternalBlobUrlsOnDispose=undefined]
5092
- */
5093
- RevokeExternalBlobUrlsOnDispose?:boolean;
5094
- /**
5095
- * This option is in effect when EmbedType is blob.
5096
- Dispose images from blob storage (revoke blob URLs) added through Value(..)
5097
- function when control is disposed. Basically ownership of these blobs are handed
5098
- over to the control for the duration of its life time.
5099
- These images are furthermore subject to the rule set in RevokeBlobUrlsOnDispose.
5100
- Defaults to False.
5101
- * @member {boolean} [RevokeExternalBlobUrlsOnDispose=undefined]
5102
- */
5103
- RevokeExternalBlobUrlsOnDispose?:boolean;
5104
- }
5105
- /**
5106
- * Configuration for image plugins.
5107
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig DesignModeConfigPluginsImagesConfig]
5108
- */
5109
- class DesignModeConfigPluginsImagesConfig
5110
- {
5111
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig
5112
- /**
5113
- * How to store and embed images. Base64 (default) is persistent while blob is temporary
5114
- and must be extracted from memory and uploaded/stored to be permanantly persisted.
5115
- References to blobs can be parsed from the HTML value produced by the editor.
5116
- * @member {'base64' | 'blob'} [EmbedType=undefined]
5117
- */
5118
- EmbedType?:'base64' | 'blob';
5119
- /**
5120
- * How to store and embed images. Base64 (default) is persistent while blob is temporary
5121
- and must be extracted from memory and uploaded/stored to be permanantly persisted.
5122
- References to blobs can be parsed from the HTML value produced by the editor.
5123
- * @member {'base64' | 'blob'} [EmbedType=undefined]
5124
- */
5125
- EmbedType?:'base64' | 'blob';
5126
- /**
5127
- * Flag indicating whether to enable image plugins or not (defaults to False).
5128
- * @member {boolean} Enabled
5129
- */
5130
- Enabled:boolean;
5131
- /**
5132
- * Flag indicating whether to enable image plugins or not (defaults to False).
5133
- * @member {boolean} Enabled
5134
- */
5135
- Enabled:boolean;
5136
- /**
5137
- * This option is in effect when EmbedType is blob.
5138
- Dispose images from blob storage (revoke blob URLs) added though image plugins when control is disposed.
5139
- If "UnreferencedOnly" is specified, the component using Fit.UI's input control will be responsible for
5140
- disposing referenced blobs. Failing to do so may cause a memory leak. Defaults to All.
5141
- * @member {'All' | 'UnreferencedOnly'} [RevokeBlobUrlsOnDispose=undefined]
5142
- */
5143
- RevokeBlobUrlsOnDispose?:'All' | 'UnreferencedOnly';
5144
- /**
5145
- * This option is in effect when EmbedType is blob.
5146
- Dispose images from blob storage (revoke blob URLs) added though image plugins when control is disposed.
5147
- If "UnreferencedOnly" is specified, the component using Fit.UI's input control will be responsible for
5148
- disposing referenced blobs. Failing to do so may cause a memory leak. Defaults to All.
5149
- * @member {'All' | 'UnreferencedOnly'} [RevokeBlobUrlsOnDispose=undefined]
5150
- */
5151
- RevokeBlobUrlsOnDispose?:'All' | 'UnreferencedOnly';
5152
- /**
5153
- * This option is in effect when EmbedType is blob.
5154
- Dispose images from blob storage (revoke blob URLs) added through Value(..)
5155
- function when control is disposed. Basically ownership of these blobs are handed
5156
- over to the control for the duration of its life time.
5157
- These images are furthermore subject to the rule set in RevokeBlobUrlsOnDispose.
5158
- Defaults to False.
5159
- * @member {boolean} [RevokeExternalBlobUrlsOnDispose=undefined]
5160
- */
5161
- RevokeExternalBlobUrlsOnDispose?:boolean;
5162
- /**
5163
- * This option is in effect when EmbedType is blob.
5164
- Dispose images from blob storage (revoke blob URLs) added through Value(..)
5165
- function when control is disposed. Basically ownership of these blobs are handed
5166
- over to the control for the duration of its life time.
5167
- These images are furthermore subject to the rule set in RevokeBlobUrlsOnDispose.
5168
- Defaults to False.
5169
- * @member {boolean} [RevokeExternalBlobUrlsOnDispose=undefined]
5170
- */
5171
- RevokeExternalBlobUrlsOnDispose?:boolean;
5172
- }
5173
- /**
5174
- * Configuration for tags in DesignMode.
5175
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigTags DesignModeConfigTags]
5176
- */
5177
- class DesignModeConfigTags
5178
- {
5179
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigTags
5180
- /**
5181
- * Name of URL parameter receiving name of JSONP callback function (only for JSONP services).
5182
- * @member {string} [JsonpCallback=undefined]
5183
- */
5184
- JsonpCallback?:string;
5185
- /**
5186
- * Name of URL parameter receiving name of JSONP callback function (only for JSONP services).
5187
- * @member {string} [JsonpCallback=undefined]
5188
- */
5189
- JsonpCallback?:string;
5190
- /**
5191
- * Number of milliseconds to allow JSONP request to wait for a response before aborting (only for JSONP services).
5192
- * @member {number} [JsonpTimeout=undefined]
5193
- */
5194
- JsonpTimeout?:number;
5195
- /**
5196
- * Number of milliseconds to allow JSONP request to wait for a response before aborting (only for JSONP services).
5197
- * @member {number} [JsonpTimeout=undefined]
5198
- */
5199
- JsonpTimeout?:number;
5200
- /**
5201
- * Event handler invoked when tags are requested. Request may be canceled by returning False.
5202
- Function receives two arguments:
5203
- Sender (Fit.Controls.Input) and EventArgs object.
5204
- EventArgs object contains the following properties:
5205
- - Sender: Fit.Controls.Input instance
5206
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5207
- - Query: Contains query information in its Marker and Query property.
5208
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest} [OnRequest=undefined]
5209
- */
5210
- OnRequest?:Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest;
5211
- /**
5212
- * Event handler invoked when tags are requested. Request may be canceled by returning False.
5213
- Function receives two arguments:
5214
- Sender (Fit.Controls.Input) and EventArgs object.
5215
- EventArgs object contains the following properties:
5216
- - Sender: Fit.Controls.Input instance
5217
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5218
- - Query: Contains query information in its Marker and Query property.
5219
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest} [OnRequest=undefined]
5220
- */
5221
- OnRequest?:Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest;
5222
- /**
5223
- * Event handler invoked when tags data is received, allowing for data transformation.
5224
- Function receives two arguments:
5225
- Sender (Fit.Controls.Input) and EventArgs object.
5226
- EventArgs object contains the following properties:
5227
- - Sender: Fit.Controls.Input instance
5228
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5229
- - Query: Contains query information in its Marker and Query property
5230
- - Tags: JSON tags array received from WebService.
5231
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse} [OnResponse=undefined]
5232
- */
5233
- OnResponse?:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse;
5234
- /**
5235
- * Event handler invoked when tags data is received, allowing for data transformation.
5236
- Function receives two arguments:
5237
- Sender (Fit.Controls.Input) and EventArgs object.
5238
- EventArgs object contains the following properties:
5239
- - Sender: Fit.Controls.Input instance
5240
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5241
- - Query: Contains query information in its Marker and Query property
5242
- - Tags: JSON tags array received from WebService.
5243
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse} [OnResponse=undefined]
5244
- */
5245
- OnResponse?:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse;
5246
- /**
5247
- * URL to request data from. Endpoint receives the following payload:
5248
- { Marker: "@", Query: "search" }
5249
-
5250
- Data is expected to be returned in the following format:
5251
- [
5252
- { Value: "t-1", Title: "Tag 1", Icon: "images/img1.jpeg", Url: "show/1", Data: "..." },
5253
- { Value: "t-2", Title: "Tag 2", Icon: "images/img2.jpeg", Url: "show/2", Data: "..." }, ...
5254
- ]
5255
-
5256
- The Value and Title properties are required. The Icon property is optional and must specify the path to an image.
5257
- The Url property is optional and must specify a path to a related page/resource.
5258
- The Data property is optional and allows for additional data to be associated with the tag.
5259
- To hold multiple values, consider using a base64 encoded JSON object:
5260
- btoa(JSON.stringify({ creationDate: new Date(), active: true }))
5261
-
5262
- The data eventuelly results in a tag being added to the editor with the following format:
5263
- Tag name 1
5264
- The data-tag-data and data-tag-context attributes are only declared if the corresponding Data and Context properties are defined in data.
5265
- * @member {string} QueryUrl
5266
- */
5267
- QueryUrl:string;
5268
- /**
5269
- * URL to request data from. Endpoint receives the following payload:
5270
- { Marker: "@", Query: "search" }
5271
-
5272
- Data is expected to be returned in the following format:
5273
- [
5274
- { Value: "t-1", Title: "Tag 1", Icon: "images/img1.jpeg", Url: "show/1", Data: "..." },
5275
- { Value: "t-2", Title: "Tag 2", Icon: "images/img2.jpeg", Url: "show/2", Data: "..." }, ...
5276
- ]
5277
-
5278
- The Value and Title properties are required. The Icon property is optional and must specify the path to an image.
5279
- The Url property is optional and must specify a path to a related page/resource.
5280
- The Data property is optional and allows for additional data to be associated with the tag.
5281
- To hold multiple values, consider using a base64 encoded JSON object:
5282
- btoa(JSON.stringify({ creationDate: new Date(), active: true }))
5283
-
5284
- The data eventuelly results in a tag being added to the editor with the following format:
5285
- Tag name 1
5286
- The data-tag-data and data-tag-context attributes are only declared if the corresponding Data and Context properties are defined in data.
5287
- * @member {string} QueryUrl
5288
- */
5289
- QueryUrl:string;
5290
- /**
5291
- * Callback invoked when a tag is being inserted into editor, allowing
5292
- for customization to the title and attributes associated with the tag.
5293
- Function receives two arguments:
5294
- Sender (Fit.Controls.Input) and EventArgs object.
5295
- EventArgs object contains the following properties:
5296
- - Sender: Fit.Controls.Input instance
5297
- - QueryMarker: String containing query marker
5298
- - Tag: JSON tag received from WebService.
5299
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator} [TagCreator=undefined]
5300
- */
5301
- TagCreator?:Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator;
5302
- /**
5303
- * Callback invoked when a tag is being inserted into editor, allowing
5304
- for customization to the title and attributes associated with the tag.
5305
- Function receives two arguments:
5306
- Sender (Fit.Controls.Input) and EventArgs object.
5307
- EventArgs object contains the following properties:
5308
- - Sender: Fit.Controls.Input instance
5309
- - QueryMarker: String containing query marker
5310
- - Tag: JSON tag received from WebService.
5311
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator} [TagCreator=undefined]
5312
- */
5313
- TagCreator?:Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator;
5314
- /**
5315
- * Markers triggering tags request and context menu.
5316
- * @member {{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[]} Triggers
5317
- */
5318
- Triggers:{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[];
5319
- /**
5320
- * Markers triggering tags request and context menu.
5321
- * @member {{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[]} Triggers
5322
- */
5323
- Triggers:{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[];
5324
- }
5325
- /**
5326
- * Configuration for tags in DesignMode.
5327
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigTags DesignModeConfigTags]
5328
- */
5329
- class DesignModeConfigTags
5330
- {
5331
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigTags
5332
- /**
5333
- * Name of URL parameter receiving name of JSONP callback function (only for JSONP services).
5334
- * @member {string} [JsonpCallback=undefined]
5335
- */
5336
- JsonpCallback?:string;
5337
- /**
5338
- * Name of URL parameter receiving name of JSONP callback function (only for JSONP services).
5339
- * @member {string} [JsonpCallback=undefined]
5340
- */
5341
- JsonpCallback?:string;
5342
- /**
5343
- * Number of milliseconds to allow JSONP request to wait for a response before aborting (only for JSONP services).
5344
- * @member {number} [JsonpTimeout=undefined]
5345
- */
5346
- JsonpTimeout?:number;
5347
- /**
5348
- * Number of milliseconds to allow JSONP request to wait for a response before aborting (only for JSONP services).
5349
- * @member {number} [JsonpTimeout=undefined]
5350
- */
5351
- JsonpTimeout?:number;
5352
- /**
5353
- * Event handler invoked when tags are requested. Request may be canceled by returning False.
5354
- Function receives two arguments:
5355
- Sender (Fit.Controls.Input) and EventArgs object.
5356
- EventArgs object contains the following properties:
5357
- - Sender: Fit.Controls.Input instance
5358
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5359
- - Query: Contains query information in its Marker and Query property.
5360
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest} [OnRequest=undefined]
5361
- */
5362
- OnRequest?:Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest;
5363
- /**
5364
- * Event handler invoked when tags are requested. Request may be canceled by returning False.
5365
- Function receives two arguments:
5366
- Sender (Fit.Controls.Input) and EventArgs object.
5367
- EventArgs object contains the following properties:
5368
- - Sender: Fit.Controls.Input instance
5369
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5370
- - Query: Contains query information in its Marker and Query property.
5371
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest} [OnRequest=undefined]
5372
- */
5373
- OnRequest?:Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest;
5374
- /**
5375
- * Event handler invoked when tags data is received, allowing for data transformation.
5376
- Function receives two arguments:
5377
- Sender (Fit.Controls.Input) and EventArgs object.
5378
- EventArgs object contains the following properties:
5379
- - Sender: Fit.Controls.Input instance
5380
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5381
- - Query: Contains query information in its Marker and Query property
5382
- - Tags: JSON tags array received from WebService.
5383
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse} [OnResponse=undefined]
5384
- */
5385
- OnResponse?:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse;
5386
- /**
5387
- * Event handler invoked when tags data is received, allowing for data transformation.
5388
- Function receives two arguments:
5389
- Sender (Fit.Controls.Input) and EventArgs object.
5390
- EventArgs object contains the following properties:
5391
- - Sender: Fit.Controls.Input instance
5392
- - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
5393
- - Query: Contains query information in its Marker and Query property
5394
- - Tags: JSON tags array received from WebService.
5395
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse} [OnResponse=undefined]
5396
- */
5397
- OnResponse?:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse;
5398
- /**
5399
- * URL to request data from. Endpoint receives the following payload:
5400
- { Marker: "@", Query: "search" }
5401
-
5402
- Data is expected to be returned in the following format:
5403
- [
5404
- { Value: "t-1", Title: "Tag 1", Icon: "images/img1.jpeg", Url: "show/1", Data: "..." },
5405
- { Value: "t-2", Title: "Tag 2", Icon: "images/img2.jpeg", Url: "show/2", Data: "..." }, ...
5406
- ]
5407
-
5408
- The Value and Title properties are required. The Icon property is optional and must specify the path to an image.
5409
- The Url property is optional and must specify a path to a related page/resource.
5410
- The Data property is optional and allows for additional data to be associated with the tag.
5411
- To hold multiple values, consider using a base64 encoded JSON object:
5412
- btoa(JSON.stringify({ creationDate: new Date(), active: true }))
5413
-
5414
- The data eventuelly results in a tag being added to the editor with the following format:
5415
- Tag name 1
5416
- The data-tag-data and data-tag-context attributes are only declared if the corresponding Data and Context properties are defined in data.
5417
- * @member {string} QueryUrl
5418
- */
5419
- QueryUrl:string;
5420
- /**
5421
- * URL to request data from. Endpoint receives the following payload:
5422
- { Marker: "@", Query: "search" }
5423
-
5424
- Data is expected to be returned in the following format:
5425
- [
5426
- { Value: "t-1", Title: "Tag 1", Icon: "images/img1.jpeg", Url: "show/1", Data: "..." },
5427
- { Value: "t-2", Title: "Tag 2", Icon: "images/img2.jpeg", Url: "show/2", Data: "..." }, ...
5428
- ]
5429
-
5430
- The Value and Title properties are required. The Icon property is optional and must specify the path to an image.
5431
- The Url property is optional and must specify a path to a related page/resource.
5432
- The Data property is optional and allows for additional data to be associated with the tag.
5433
- To hold multiple values, consider using a base64 encoded JSON object:
5434
- btoa(JSON.stringify({ creationDate: new Date(), active: true }))
5435
-
5436
- The data eventuelly results in a tag being added to the editor with the following format:
5437
- Tag name 1
5438
- The data-tag-data and data-tag-context attributes are only declared if the corresponding Data and Context properties are defined in data.
5439
- * @member {string} QueryUrl
5440
- */
5441
- QueryUrl:string;
5442
- /**
5443
- * Callback invoked when a tag is being inserted into editor, allowing
5444
- for customization to the title and attributes associated with the tag.
5445
- Function receives two arguments:
5446
- Sender (Fit.Controls.Input) and EventArgs object.
5447
- EventArgs object contains the following properties:
5448
- - Sender: Fit.Controls.Input instance
5449
- - QueryMarker: String containing query marker
5450
- - Tag: JSON tag received from WebService.
5451
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator} [TagCreator=undefined]
5452
- */
5453
- TagCreator?:Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator;
5454
- /**
5455
- * Callback invoked when a tag is being inserted into editor, allowing
5456
- for customization to the title and attributes associated with the tag.
5457
- Function receives two arguments:
5458
- Sender (Fit.Controls.Input) and EventArgs object.
5459
- EventArgs object contains the following properties:
5460
- - Sender: Fit.Controls.Input instance
5461
- - QueryMarker: String containing query marker
5462
- - Tag: JSON tag received from WebService.
5463
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator} [TagCreator=undefined]
5464
- */
5465
- TagCreator?:Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator;
5466
- /**
5467
- * Markers triggering tags request and context menu.
5468
- * @member {{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[]} Triggers
5469
- */
5470
- Triggers:{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[];
5471
- /**
5472
- * Markers triggering tags request and context menu.
5473
- * @member {{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[]} Triggers
5474
- */
5475
- Triggers:{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[];
5476
- }
5477
- /**
5478
- * Toolbar buttons enabled in DesignMode.
5479
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigToolbar DesignModeConfigToolbar]
5480
- */
5481
- class DesignModeConfigToolbar
5482
- {
5483
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigToolbar
5484
- /**
5485
- * Enable detach button (defaults to false).
5486
- * @member {boolean} [Detach=undefined]
5487
- */
5488
- Detach?:boolean;
5489
- /**
5490
- * Enable detach button (defaults to false).
5491
- * @member {boolean} [Detach=undefined]
5492
- */
5493
- Detach?:boolean;
5494
- /**
5495
- * Enable emoji button (defaults to False).
5496
- * @member {boolean} [Emojis=undefined]
5497
- */
5498
- Emojis?:boolean;
5499
- /**
5500
- * Enable emoji button (defaults to False).
5501
- * @member {boolean} [Emojis=undefined]
5502
- */
5503
- Emojis?:boolean;
5504
- /**
5505
- * Enable text formatting (bold, italic, underline) (defaults to True).
5506
- * @member {boolean} [Formatting=undefined]
5507
- */
5508
- Formatting?:boolean;
5509
- /**
5510
- * Enable text formatting (bold, italic, underline) (defaults to True).
5511
- * @member {boolean} [Formatting=undefined]
5512
- */
5513
- Formatting?:boolean;
5514
- /**
5515
- * Hide toolbar until control gains focus (defaults to False).
5516
- * @member {boolean} [HideInitially=undefined]
5517
- */
5518
- HideInitially?:boolean;
5519
- /**
5520
- * Hide toolbar until control gains focus (defaults to False).
5521
- * @member {boolean} [HideInitially=undefined]
5522
- */
5523
- HideInitially?:boolean;
5524
- /**
5525
- * Enable image button (defaults to false).
5526
- * @member {boolean} [Images=undefined]
5527
- */
5528
- Images?:boolean;
5529
- /**
5530
- * Enable image button (defaults to false).
5531
- * @member {boolean} [Images=undefined]
5532
- */
5533
- Images?:boolean;
5534
- /**
5535
- * Enable text alignment (defaults to True).
5536
- * @member {boolean} [Justify=undefined]
5537
- */
5538
- Justify?:boolean;
5539
- /**
5540
- * Enable text alignment (defaults to True).
5541
- * @member {boolean} [Justify=undefined]
5542
- */
5543
- Justify?:boolean;
5544
- /**
5545
- * Enable links (defaults to True).
5546
- * @member {boolean} [Links=undefined]
5547
- */
5548
- Links?:boolean;
5549
- /**
5550
- * Enable links (defaults to True).
5551
- * @member {boolean} [Links=undefined]
5552
- */
5553
- Links?:boolean;
5554
- /**
5555
- * Enable ordered and unordered lists with indentation (defaults to True).
5556
- * @member {boolean} [Lists=undefined]
5557
- */
5558
- Lists?:boolean;
5559
- /**
5560
- * Enable ordered and unordered lists with indentation (defaults to True).
5561
- * @member {boolean} [Lists=undefined]
5562
- */
5563
- Lists?:boolean;
5564
- /**
5565
- * Toolbar position (defaults to Top).
5566
- * @member {'Top' | 'Bottom'} [Position=undefined]
5567
- */
5568
- Position?:'Top' | 'Bottom';
5569
- /**
5570
- * Toolbar position (defaults to Top).
5571
- * @member {'Top' | 'Bottom'} [Position=undefined]
5572
- */
5573
- Position?:'Top' | 'Bottom';
5574
- /**
5575
- * Make toolbar stick to edge of scroll container on supported browsers when scrolling (defaults to False).
5576
- * @member {boolean} [Sticky=undefined]
5577
- */
5578
- Sticky?:boolean;
5579
- /**
5580
- * Make toolbar stick to edge of scroll container on supported browsers when scrolling (defaults to False).
5581
- * @member {boolean} [Sticky=undefined]
5582
- */
5583
- Sticky?:boolean;
5584
- }
5585
- /**
5586
- * Toolbar buttons enabled in DesignMode.
5587
- * @class [Fit.Controls.InputTypeDefs.DesignModeConfigToolbar DesignModeConfigToolbar]
5588
- */
5589
- class DesignModeConfigToolbar
5590
- {
5591
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigToolbar
5592
- /**
5593
- * Enable detach button (defaults to false).
5594
- * @member {boolean} [Detach=undefined]
5595
- */
5596
- Detach?:boolean;
5597
- /**
5598
- * Enable detach button (defaults to false).
5599
- * @member {boolean} [Detach=undefined]
5600
- */
5601
- Detach?:boolean;
5602
- /**
5603
- * Enable emoji button (defaults to False).
5604
- * @member {boolean} [Emojis=undefined]
5605
- */
5606
- Emojis?:boolean;
5607
- /**
5608
- * Enable emoji button (defaults to False).
5609
- * @member {boolean} [Emojis=undefined]
5610
- */
5611
- Emojis?:boolean;
5612
- /**
5613
- * Enable text formatting (bold, italic, underline) (defaults to True).
5614
- * @member {boolean} [Formatting=undefined]
5615
- */
5616
- Formatting?:boolean;
5617
- /**
5618
- * Enable text formatting (bold, italic, underline) (defaults to True).
5619
- * @member {boolean} [Formatting=undefined]
5620
- */
5621
- Formatting?:boolean;
5622
- /**
5623
- * Hide toolbar until control gains focus (defaults to False).
5624
- * @member {boolean} [HideInitially=undefined]
5625
- */
5626
- HideInitially?:boolean;
5627
- /**
5628
- * Hide toolbar until control gains focus (defaults to False).
5629
- * @member {boolean} [HideInitially=undefined]
5630
- */
5631
- HideInitially?:boolean;
5632
- /**
5633
- * Enable image button (defaults to false).
5634
- * @member {boolean} [Images=undefined]
5635
- */
5636
- Images?:boolean;
5637
- /**
5638
- * Enable image button (defaults to false).
5639
- * @member {boolean} [Images=undefined]
5640
- */
5641
- Images?:boolean;
5642
- /**
5643
- * Enable text alignment (defaults to True).
5644
- * @member {boolean} [Justify=undefined]
5645
- */
5646
- Justify?:boolean;
5647
- /**
5648
- * Enable text alignment (defaults to True).
5649
- * @member {boolean} [Justify=undefined]
5650
- */
5651
- Justify?:boolean;
5652
- /**
5653
- * Enable links (defaults to True).
5654
- * @member {boolean} [Links=undefined]
5655
- */
5656
- Links?:boolean;
5657
- /**
5658
- * Enable links (defaults to True).
5659
- * @member {boolean} [Links=undefined]
5660
- */
5661
- Links?:boolean;
5662
- /**
5663
- * Enable ordered and unordered lists with indentation (defaults to True).
5664
- * @member {boolean} [Lists=undefined]
5665
- */
5666
- Lists?:boolean;
5667
- /**
5668
- * Enable ordered and unordered lists with indentation (defaults to True).
5669
- * @member {boolean} [Lists=undefined]
5670
- */
5671
- Lists?:boolean;
5672
- /**
5673
- * Toolbar position (defaults to Top).
5674
- * @member {'Top' | 'Bottom'} [Position=undefined]
5675
- */
5676
- Position?:'Top' | 'Bottom';
5677
- /**
5678
- * Toolbar position (defaults to Top).
5679
- * @member {'Top' | 'Bottom'} [Position=undefined]
5680
- */
5681
- Position?:'Top' | 'Bottom';
5682
- /**
5683
- * Make toolbar stick to edge of scroll container on supported browsers when scrolling (defaults to False).
5684
- * @member {boolean} [Sticky=undefined]
5685
- */
5686
- Sticky?:boolean;
5687
- /**
5688
- * Make toolbar stick to edge of scroll container on supported browsers when scrolling (defaults to False).
5689
- * @member {boolean} [Sticky=undefined]
5690
- */
5691
- Sticky?:boolean;
5692
- }
5693
- /**
5694
- * Detachable configuration.
5695
- * @class [Fit.Controls.InputTypeDefs.DesignModeDetachable DesignModeDetachable]
5696
- */
5697
- class DesignModeDetachable
5698
- {
5699
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeDetachable
5700
- /**
5701
- * Flag indicating whether dialog is draggable.
5702
- * @member {boolean} [Draggable=undefined]
5703
- */
5704
- Draggable?:boolean;
5705
- /**
5706
- * Flag indicating whether dialog is draggable.
5707
- * @member {boolean} [Draggable=undefined]
5708
- */
5709
- Draggable?:boolean;
5710
- /**
5711
- * Dialog height.
5712
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Height=undefined]
5713
- */
5714
- Height?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5715
- /**
5716
- * Dialog height.
5717
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Height=undefined]
5718
- */
5719
- Height?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5720
- /**
5721
- * Flag indicating whether dialog is maximizable.
5722
- * @member {boolean} [Maximizable=undefined]
5723
- */
5724
- Maximizable?:boolean;
5725
- /**
5726
- * Flag indicating whether dialog is maximizable.
5727
- * @member {boolean} [Maximizable=undefined]
5728
- */
5729
- Maximizable?:boolean;
5730
- /**
5731
- * Flag indicating whether dialog is initially maximized.
5732
- * @member {boolean} [Maximized=undefined]
5733
- */
5734
- Maximized?:boolean;
5735
- /**
5736
- * Flag indicating whether dialog is initially maximized.
5737
- * @member {boolean} [Maximized=undefined]
5738
- */
5739
- Maximized?:boolean;
5740
- /**
5741
- * Maximum height of dialog.
5742
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
5743
- */
5744
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5745
- /**
5746
- * Maximum height of dialog.
5747
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
5748
- */
5749
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5750
- /**
5751
- * Maximum Width of dialog.
5752
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumWidth=undefined]
5753
- */
5754
- MaximumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5755
- /**
5756
- * Maximum Width of dialog.
5757
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumWidth=undefined]
5758
- */
5759
- MaximumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5760
- /**
5761
- * Minimum height of dialog.
5762
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
5763
- */
5764
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5765
- /**
5766
- * Minimum height of dialog.
5767
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
5768
- */
5769
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5770
- /**
5771
- * Minimum width of dialog.
5772
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumWidth=undefined]
5773
- */
5774
- MinimumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5775
- /**
5776
- * Minimum width of dialog.
5777
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumWidth=undefined]
5778
- */
5779
- MinimumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5780
- /**
5781
- * Flag indicating whether dialog is resizable.
5782
- * @member {boolean} [Resizable=undefined]
5783
- */
5784
- Resizable?:boolean;
5785
- /**
5786
- * Flag indicating whether dialog is resizable.
5787
- * @member {boolean} [Resizable=undefined]
5788
- */
5789
- Resizable?:boolean;
5790
- /**
5791
- * Dialog title.
5792
- * @member {string} [Title=undefined]
5793
- */
5794
- Title?:string;
5795
- /**
5796
- * Dialog title.
5797
- * @member {string} [Title=undefined]
5798
- */
5799
- Title?:string;
5800
- /**
5801
- * Dialog width.
5802
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Width=undefined]
5803
- */
5804
- Width?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5805
- /**
5806
- * Dialog width.
5807
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Width=undefined]
5808
- */
5809
- Width?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5810
- }
5811
- /**
5812
- * Detachable configuration.
5813
- * @class [Fit.Controls.InputTypeDefs.DesignModeDetachable DesignModeDetachable]
5814
- */
5815
- class DesignModeDetachable
5816
- {
5817
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeDetachable
5818
- /**
5819
- * Flag indicating whether dialog is draggable.
5820
- * @member {boolean} [Draggable=undefined]
5821
- */
5822
- Draggable?:boolean;
5823
- /**
5824
- * Flag indicating whether dialog is draggable.
5825
- * @member {boolean} [Draggable=undefined]
5826
- */
5827
- Draggable?:boolean;
5828
- /**
5829
- * Dialog height.
5830
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Height=undefined]
5831
- */
5832
- Height?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5833
- /**
5834
- * Dialog height.
5835
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Height=undefined]
5836
- */
5837
- Height?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5838
- /**
5839
- * Flag indicating whether dialog is maximizable.
5840
- * @member {boolean} [Maximizable=undefined]
5841
- */
5842
- Maximizable?:boolean;
5843
- /**
5844
- * Flag indicating whether dialog is maximizable.
5845
- * @member {boolean} [Maximizable=undefined]
5846
- */
5847
- Maximizable?:boolean;
5848
- /**
5849
- * Flag indicating whether dialog is initially maximized.
5850
- * @member {boolean} [Maximized=undefined]
5851
- */
5852
- Maximized?:boolean;
5853
- /**
5854
- * Flag indicating whether dialog is initially maximized.
5855
- * @member {boolean} [Maximized=undefined]
5856
- */
5857
- Maximized?:boolean;
5858
- /**
5859
- * Maximum height of dialog.
5860
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
5861
- */
5862
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5863
- /**
5864
- * Maximum height of dialog.
5865
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
5866
- */
5867
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5868
- /**
5869
- * Maximum Width of dialog.
5870
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumWidth=undefined]
5871
- */
5872
- MaximumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5873
- /**
5874
- * Maximum Width of dialog.
5875
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumWidth=undefined]
5876
- */
5877
- MaximumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5878
- /**
5879
- * Minimum height of dialog.
5880
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
5881
- */
5882
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5883
- /**
5884
- * Minimum height of dialog.
5885
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
5886
- */
5887
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5888
- /**
5889
- * Minimum width of dialog.
5890
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumWidth=undefined]
5891
- */
5892
- MinimumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5893
- /**
5894
- * Minimum width of dialog.
5895
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumWidth=undefined]
5896
- */
5897
- MinimumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5898
- /**
5899
- * Flag indicating whether dialog is resizable.
5900
- * @member {boolean} [Resizable=undefined]
5901
- */
5902
- Resizable?:boolean;
5903
- /**
5904
- * Flag indicating whether dialog is resizable.
5905
- * @member {boolean} [Resizable=undefined]
5906
- */
5907
- Resizable?:boolean;
5908
- /**
5909
- * Dialog title.
5910
- * @member {string} [Title=undefined]
5911
- */
5912
- Title?:string;
5913
- /**
5914
- * Dialog title.
5915
- * @member {string} [Title=undefined]
5916
- */
5917
- Title?:string;
5918
- /**
5919
- * Dialog width.
5920
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Width=undefined]
5921
- */
5922
- Width?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5923
- /**
5924
- * Dialog width.
5925
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Width=undefined]
5926
- */
5927
- Width?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5928
- }
5929
- /**
5930
- * DialogMode configuration.
5931
- * @class [Fit.Controls.InputTypeDefs.DesignModeDialogMode DesignModeDialogMode]
5932
- */
5933
- class DesignModeDialogMode
5934
- {
5935
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeDialogMode
5936
- /**
5937
- * Flag indicating whether dialog is automatically opened.
5938
- * @member {boolean} [AutoOpen=undefined]
5939
- */
5940
- AutoOpen?:boolean;
5941
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeDetachable
5942
- /**
5943
- * Flag indicating whether dialog is draggable.
5944
- * @member {boolean} [Draggable=undefined]
5945
- */
5946
- Draggable?:boolean;
5947
- /**
5948
- * Flag indicating whether dialog is draggable.
5949
- * @member {boolean} [Draggable=undefined]
5950
- */
5951
- Draggable?:boolean;
5952
- /**
5953
- * Dialog height.
5954
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Height=undefined]
5955
- */
5956
- Height?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5957
- /**
5958
- * Dialog height.
5959
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Height=undefined]
5960
- */
5961
- Height?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5962
- /**
5963
- * Flag indicating whether dialog is maximizable.
5964
- * @member {boolean} [Maximizable=undefined]
5965
- */
5966
- Maximizable?:boolean;
5967
- /**
5968
- * Flag indicating whether dialog is maximizable.
5969
- * @member {boolean} [Maximizable=undefined]
5970
- */
5971
- Maximizable?:boolean;
5972
- /**
5973
- * Flag indicating whether dialog is initially maximized.
5974
- * @member {boolean} [Maximized=undefined]
5975
- */
5976
- Maximized?:boolean;
5977
- /**
5978
- * Flag indicating whether dialog is initially maximized.
5979
- * @member {boolean} [Maximized=undefined]
5980
- */
5981
- Maximized?:boolean;
5982
- /**
5983
- * Maximum height of dialog.
5984
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
5985
- */
5986
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5987
- /**
5988
- * Maximum height of dialog.
5989
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
5990
- */
5991
- MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5992
- /**
5993
- * Maximum Width of dialog.
5994
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumWidth=undefined]
5995
- */
5996
- MaximumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
5997
- /**
5998
- * Maximum Width of dialog.
5999
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumWidth=undefined]
6000
- */
6001
- MaximumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6002
- /**
6003
- * Minimum height of dialog.
6004
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
6005
- */
6006
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6007
- /**
6008
- * Minimum height of dialog.
6009
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
6010
- */
6011
- MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6012
- /**
6013
- * Minimum width of dialog.
6014
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumWidth=undefined]
6015
- */
6016
- MinimumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6017
- /**
6018
- * Minimum width of dialog.
6019
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumWidth=undefined]
6020
- */
6021
- MinimumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6022
- /**
6023
- * Flag indicating whether dialog is resizable.
6024
- * @member {boolean} [Resizable=undefined]
6025
- */
6026
- Resizable?:boolean;
6027
- /**
6028
- * Flag indicating whether dialog is resizable.
6029
- * @member {boolean} [Resizable=undefined]
6030
- */
6031
- Resizable?:boolean;
6032
- /**
6033
- * Dialog title.
6034
- * @member {string} [Title=undefined]
6035
- */
6036
- Title?:string;
6037
- /**
6038
- * Dialog title.
6039
- * @member {string} [Title=undefined]
6040
- */
6041
- Title?:string;
6042
- /**
6043
- * Dialog width.
6044
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Width=undefined]
6045
- */
6046
- Width?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6047
- /**
6048
- * Dialog width.
6049
- * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Width=undefined]
6050
- */
6051
- Width?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6052
- }
6053
- /**
6054
- * Request handler event arguments.
6055
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs DesignModeTagsOnRequestEventHandlerArgs]
6056
- */
6057
- class DesignModeTagsOnRequestEventHandlerArgs
6058
- {
6059
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs
6060
- /**
6061
- * Query information.
6062
- * @member {{ Marker: string, Query: string }} Query
6063
- */
6064
- Query:{ Marker: string, Query: string };
6065
- /**
6066
- * Query information.
6067
- * @member {{ Marker: string, Query: string }} Query
6068
- */
6069
- Query:{ Marker: string, Query: string };
6070
- /**
6071
- * Instance of JsonRequest or JsonpRequest.
6072
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
6073
- */
6074
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4495
+ Enabled:boolean;
6075
4496
  /**
6076
- * Instance of JsonRequest or JsonpRequest.
6077
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
4497
+ * Maximum height of editable area.
4498
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
6078
4499
  */
6079
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4500
+ MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6080
4501
  /**
6081
- * Instance of control.
6082
- * @member {Fit.Controls.Input} Sender
4502
+ * Minimum height of editable area.
4503
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
6083
4504
  */
6084
- Sender:Fit.Controls.Input;
4505
+ MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6085
4506
  /**
6086
- * Instance of control.
6087
- * @member {Fit.Controls.Input} Sender
4507
+ * Prevent user from resizing editor beyond maximum height (see MaximumHeight property - defaults to False).
4508
+ * @member {boolean} [PreventResizeBeyondMaximumHeight=undefined]
6088
4509
  */
6089
- Sender:Fit.Controls.Input;
4510
+ PreventResizeBeyondMaximumHeight?:boolean;
6090
4511
  }
6091
4512
  /**
6092
- * Request handler event arguments.
6093
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs DesignModeTagsOnRequestEventHandlerArgs]
4513
+ * Configuration for DesignMode.
4514
+ * @class [Fit.Controls.InputTypeDefs.DesignModeConfig DesignModeConfig]
6094
4515
  */
6095
- class DesignModeTagsOnRequestEventHandlerArgs
4516
+ class DesignModeConfig
6096
4517
  {
6097
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs
4518
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfig
6098
4519
  /**
6099
- * Query information.
6100
- * @member {{ Marker: string, Query: string }} Query
4520
+ * Auto grow configuration.
4521
+ * @member {Fit.Controls.InputTypeDefs.DesignModeAutoGrow} [AutoGrow=undefined]
6101
4522
  */
6102
- Query:{ Marker: string, Query: string };
4523
+ AutoGrow?:Fit.Controls.InputTypeDefs.DesignModeAutoGrow;
6103
4524
  /**
6104
- * Query information.
6105
- * @member {{ Marker: string, Query: string }} Query
4525
+ * Detachable configuration.
4526
+ * @member {Fit.Controls.InputTypeDefs.DesignModeDetachable} [Detachable=undefined]
6106
4527
  */
6107
- Query:{ Marker: string, Query: string };
4528
+ Detachable?:Fit.Controls.InputTypeDefs.DesignModeDetachable;
6108
4529
  /**
6109
- * Instance of JsonRequest or JsonpRequest.
6110
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
4530
+ * Information panel configuration.
4531
+ * @member {Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel} [InfoPanel=undefined]
6111
4532
  */
6112
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4533
+ InfoPanel?:Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel;
6113
4534
  /**
6114
- * Instance of JsonRequest or JsonpRequest.
6115
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
4535
+ * Plugins configuration.
4536
+ * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPlugins} [Plugins=undefined]
6116
4537
  */
6117
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4538
+ Plugins?:Fit.Controls.InputTypeDefs.DesignModeConfigPlugins;
6118
4539
  /**
6119
- * Instance of control.
6120
- * @member {Fit.Controls.Input} Sender
4540
+ * Tags configuration.
4541
+ * @member {Fit.Controls.InputTypeDefs.DesignModeConfigTags} [Tags=undefined]
6121
4542
  */
6122
- Sender:Fit.Controls.Input;
4543
+ Tags?:Fit.Controls.InputTypeDefs.DesignModeConfigTags;
6123
4544
  /**
6124
- * Instance of control.
6125
- * @member {Fit.Controls.Input} Sender
4545
+ * Toolbar configuration.
4546
+ * @member {Fit.Controls.InputTypeDefs.DesignModeConfigToolbar} [Toolbar=undefined]
6126
4547
  */
6127
- Sender:Fit.Controls.Input;
4548
+ Toolbar?:Fit.Controls.InputTypeDefs.DesignModeConfigToolbar;
6128
4549
  }
6129
4550
  /**
6130
- * Response handler event arguments.
6131
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs DesignModeTagsOnResponseEventHandlerArgs]
4551
+ * Information panel at the top or bottom of the editor, depending on the location of the toolbar.
4552
+ * @class [Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel DesignModeConfigInfoPanel]
6132
4553
  */
6133
- class DesignModeTagsOnResponseEventHandlerArgs
4554
+ class DesignModeConfigInfoPanel
6134
4555
  {
6135
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs
4556
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigInfoPanel
6136
4557
  /**
6137
- * Query information.
6138
- * @member {{ Marker: string, Query: string }} Query
4558
+ * Text alignment - defaults to Center.
4559
+ * @member {'Left' | 'Center' | 'Right'} [Alignment=undefined]
6139
4560
  */
6140
- Query:{ Marker: string, Query: string };
4561
+ Alignment?:'Left' | 'Center' | 'Right';
6141
4562
  /**
6142
- * Query information.
6143
- * @member {{ Marker: string, Query: string }} Query
4563
+ * Text to display.
4564
+ * @member {string} [Text=undefined]
6144
4565
  */
6145
- Query:{ Marker: string, Query: string };
4566
+ Text?:string;
4567
+ }
4568
+ /**
4569
+ * Additional plugins enabled in DesignMode.
4570
+ * @class [Fit.Controls.InputTypeDefs.DesignModeConfigPlugins DesignModeConfigPlugins]
4571
+ */
4572
+ class DesignModeConfigPlugins
4573
+ {
4574
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigPlugins
6146
4575
  /**
6147
- * Instance of JsonRequest or JsonpRequest.
6148
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
4576
+ * Plugin(s) related to emoji support (defaults to False).
4577
+ * @member {boolean} [Emojis=undefined]
6149
4578
  */
6150
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4579
+ Emojis?:boolean;
6151
4580
  /**
6152
- * Instance of JsonRequest or JsonpRequest.
6153
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
4581
+ * Plugin(s) related to support for images (defaults to False).
4582
+ * @member {Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig} [Images=undefined]
6154
4583
  */
6155
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4584
+ Images?:Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig;
4585
+ }
4586
+ /**
4587
+ * Configuration for image plugins.
4588
+ * @class [Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig DesignModeConfigPluginsImagesConfig]
4589
+ */
4590
+ class DesignModeConfigPluginsImagesConfig
4591
+ {
4592
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigPluginsImagesConfig
6156
4593
  /**
6157
- * Instance of control.
6158
- * @member {Fit.Controls.Input} Sender
4594
+ * How to store and embed images. Base64 (default) is persistent while blob is temporary
4595
+ and must be extracted from memory and uploaded/stored to be permanantly persisted.
4596
+ References to blobs can be parsed from the HTML value produced by the editor.
4597
+ * @member {'base64' | 'blob'} [EmbedType=undefined]
6159
4598
  */
6160
- Sender:Fit.Controls.Input;
4599
+ EmbedType?:'base64' | 'blob';
6161
4600
  /**
6162
- * Instance of control.
6163
- * @member {Fit.Controls.Input} Sender
4601
+ * Flag indicating whether to enable image plugins or not (defaults to False).
4602
+ * @member {boolean} Enabled
6164
4603
  */
6165
- Sender:Fit.Controls.Input;
4604
+ Enabled:boolean;
6166
4605
  /**
6167
- * Tags received from WebService.
6168
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[]} Tags
4606
+ * This option is in effect when EmbedType is blob.
4607
+ Dispose images from blob storage (revoke blob URLs) added though image plugins when control is disposed.
4608
+ If "UnreferencedOnly" is specified, the component using Fit.UI's input control will be responsible for
4609
+ disposing referenced blobs. Failing to do so may cause a memory leak. Defaults to All.
4610
+ * @member {'All' | 'UnreferencedOnly'} [RevokeBlobUrlsOnDispose=undefined]
6169
4611
  */
6170
- Tags:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[];
4612
+ RevokeBlobUrlsOnDispose?:'All' | 'UnreferencedOnly';
6171
4613
  /**
6172
- * Tags received from WebService.
6173
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[]} Tags
4614
+ * This option is in effect when EmbedType is blob.
4615
+ Dispose images from blob storage (revoke blob URLs) added through Value(..)
4616
+ function when control is disposed. Basically ownership of these blobs are handed
4617
+ over to the control for the duration of its life time.
4618
+ These images are furthermore subject to the rule set in RevokeBlobUrlsOnDispose.
4619
+ Defaults to False.
4620
+ * @member {boolean} [RevokeExternalBlobUrlsOnDispose=undefined]
6174
4621
  */
6175
- Tags:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[];
4622
+ RevokeExternalBlobUrlsOnDispose?:boolean;
6176
4623
  }
6177
4624
  /**
6178
- * Response handler event arguments.
6179
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs DesignModeTagsOnResponseEventHandlerArgs]
4625
+ * Configuration for tags in DesignMode.
4626
+ * @class [Fit.Controls.InputTypeDefs.DesignModeConfigTags DesignModeConfigTags]
6180
4627
  */
6181
- class DesignModeTagsOnResponseEventHandlerArgs
4628
+ class DesignModeConfigTags
6182
4629
  {
6183
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs
6184
- /**
6185
- * Query information.
6186
- * @member {{ Marker: string, Query: string }} Query
6187
- */
6188
- Query:{ Marker: string, Query: string };
6189
- /**
6190
- * Query information.
6191
- * @member {{ Marker: string, Query: string }} Query
6192
- */
6193
- Query:{ Marker: string, Query: string };
6194
- /**
6195
- * Instance of JsonRequest or JsonpRequest.
6196
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
6197
- */
6198
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4630
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigTags
6199
4631
  /**
6200
- * Instance of JsonRequest or JsonpRequest.
6201
- * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
4632
+ * Name of URL parameter receiving name of JSONP callback function (only for JSONP services).
4633
+ * @member {string} [JsonpCallback=undefined]
6202
4634
  */
6203
- Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
4635
+ JsonpCallback?:string;
6204
4636
  /**
6205
- * Instance of control.
6206
- * @member {Fit.Controls.Input} Sender
4637
+ * Number of milliseconds to allow JSONP request to wait for a response before aborting (only for JSONP services).
4638
+ * @member {number} [JsonpTimeout=undefined]
6207
4639
  */
6208
- Sender:Fit.Controls.Input;
4640
+ JsonpTimeout?:number;
6209
4641
  /**
6210
- * Instance of control.
6211
- * @member {Fit.Controls.Input} Sender
4642
+ * Event handler invoked when tags are requested. Request may be canceled by returning False.
4643
+ Function receives two arguments:
4644
+ Sender (Fit.Controls.Input) and EventArgs object.
4645
+ EventArgs object contains the following properties:
4646
+ - Sender: Fit.Controls.Input instance
4647
+ - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
4648
+ - Query: Contains query information in its Marker and Query property.
4649
+ * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest} [OnRequest=undefined]
6212
4650
  */
6213
- Sender:Fit.Controls.Input;
4651
+ OnRequest?:Fit.Controls.InputTypeDefs.DesignModeTagsOnRequest;
6214
4652
  /**
6215
- * Tags received from WebService.
6216
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[]} Tags
4653
+ * Event handler invoked when tags data is received, allowing for data transformation.
4654
+ Function receives two arguments:
4655
+ Sender (Fit.Controls.Input) and EventArgs object.
4656
+ EventArgs object contains the following properties:
4657
+ - Sender: Fit.Controls.Input instance
4658
+ - Request: Fit.Http.JsonpRequest or Fit.Http.JsonRequest instance
4659
+ - Query: Contains query information in its Marker and Query property
4660
+ - Tags: JSON tags array received from WebService.
4661
+ * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse} [OnResponse=undefined]
6217
4662
  */
6218
- Tags:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[];
4663
+ OnResponse?:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponse;
6219
4664
  /**
6220
- * Tags received from WebService.
6221
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[]} Tags
4665
+ * URL to request data from. Endpoint receives the following payload:
4666
+ { Marker: "@", Query: "search" }
4667
+
4668
+ Data is expected to be returned in the following format:
4669
+ [
4670
+ { Value: "t-1", Title: "Tag 1", Icon: "images/img1.jpeg", Url: "show/1", Data: "..." },
4671
+ { Value: "t-2", Title: "Tag 2", Icon: "images/img2.jpeg", Url: "show/2", Data: "..." }, ...
4672
+ ]
4673
+
4674
+ The Value and Title properties are required. The Icon property is optional and must specify the path to an image.
4675
+ The Url property is optional and must specify a path to a related page/resource.
4676
+ The Data property is optional and allows for additional data to be associated with the tag.
4677
+ To hold multiple values, consider using a base64 encoded JSON object:
4678
+ btoa(JSON.stringify({ creationDate: new Date(), active: true }))
4679
+
4680
+ The data eventuelly results in a tag being added to the editor with the following format:
4681
+ Tag name 1
4682
+ The data-tag-data and data-tag-context attributes are only declared if the corresponding Data and Context properties are defined in data.
4683
+ * @member {string} QueryUrl
6222
4684
  */
6223
- Tags:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[];
6224
- }
6225
- /**
6226
- * JSON object representing tag.
6227
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag DesignModeTagsOnResponseJsonTag]
6228
- */
6229
- class DesignModeTagsOnResponseJsonTag
6230
- {
6231
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag
4685
+ QueryUrl:string;
6232
4686
  /**
6233
- * Optional context information to associate with tag.
6234
- * @member {string} [Context=undefined]
4687
+ * Callback invoked when a tag is being inserted into editor, allowing
4688
+ for customization to the title and attributes associated with the tag.
4689
+ Function receives two arguments:
4690
+ Sender (Fit.Controls.Input) and EventArgs object.
4691
+ EventArgs object contains the following properties:
4692
+ - Sender: Fit.Controls.Input instance
4693
+ - QueryMarker: String containing query marker
4694
+ - Tag: JSON tag received from WebService.
4695
+ * @member {Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator} [TagCreator=undefined]
6235
4696
  */
6236
- Context?:string;
4697
+ TagCreator?:Fit.Controls.InputTypeDefs.DesignModeTagsTagCreator;
6237
4698
  /**
6238
- * Optional context information to associate with tag.
6239
- * @member {string} [Context=undefined]
4699
+ * Markers triggering tags request and context menu.
4700
+ * @member {{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[]} Triggers
6240
4701
  */
6241
- Context?:string;
4702
+ Triggers:{ Marker: string, MinimumCharacters?: number, DebounceQuery?: number }[];
4703
+ }
4704
+ /**
4705
+ * Toolbar buttons enabled in DesignMode.
4706
+ * @class [Fit.Controls.InputTypeDefs.DesignModeConfigToolbar DesignModeConfigToolbar]
4707
+ */
4708
+ class DesignModeConfigToolbar
4709
+ {
4710
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeConfigToolbar
6242
4711
  /**
6243
- * Optional data to associate with tag.
6244
- * @member {string} [Data=undefined]
4712
+ * Enable detach button (defaults to false).
4713
+ * @member {boolean} [Detach=undefined]
6245
4714
  */
6246
- Data?:string;
4715
+ Detach?:boolean;
6247
4716
  /**
6248
- * Optional data to associate with tag.
6249
- * @member {string} [Data=undefined]
4717
+ * Enable emoji button (defaults to False).
4718
+ * @member {boolean} [Emojis=undefined]
6250
4719
  */
6251
- Data?:string;
4720
+ Emojis?:boolean;
6252
4721
  /**
6253
- * Optional URL to icon/image.
6254
- * @member {string} [Icon=undefined]
4722
+ * Enable text formatting (bold, italic, underline) (defaults to True).
4723
+ * @member {boolean} [Formatting=undefined]
6255
4724
  */
6256
- Icon?:string;
4725
+ Formatting?:boolean;
6257
4726
  /**
6258
- * Optional URL to icon/image.
6259
- * @member {string} [Icon=undefined]
4727
+ * Hide toolbar until control gains focus (defaults to False).
4728
+ * @member {boolean} [HideInitially=undefined]
6260
4729
  */
6261
- Icon?:string;
4730
+ HideInitially?:boolean;
6262
4731
  /**
6263
- * Title.
6264
- * @member {string} Title
4732
+ * Enable image button (defaults to false).
4733
+ * @member {boolean} [Images=undefined]
6265
4734
  */
6266
- Title:string;
4735
+ Images?:boolean;
6267
4736
  /**
6268
- * Title.
6269
- * @member {string} Title
4737
+ * Enable text alignment (defaults to True).
4738
+ * @member {boolean} [Justify=undefined]
6270
4739
  */
6271
- Title:string;
4740
+ Justify?:boolean;
6272
4741
  /**
6273
- * Optional URL to associate with tag.
6274
- * @member {string} [Url=undefined]
4742
+ * Enable links (defaults to True).
4743
+ * @member {boolean} [Links=undefined]
6275
4744
  */
6276
- Url?:string;
4745
+ Links?:boolean;
6277
4746
  /**
6278
- * Optional URL to associate with tag.
6279
- * @member {string} [Url=undefined]
4747
+ * Enable ordered and unordered lists with indentation (defaults to True).
4748
+ * @member {boolean} [Lists=undefined]
6280
4749
  */
6281
- Url?:string;
4750
+ Lists?:boolean;
6282
4751
  /**
6283
- * Unique value.
6284
- * @member {string} Value
4752
+ * Toolbar position (defaults to Top).
4753
+ * @member {'Top' | 'Bottom'} [Position=undefined]
6285
4754
  */
6286
- Value:string;
4755
+ Position?:'Top' | 'Bottom';
6287
4756
  /**
6288
- * Unique value.
6289
- * @member {string} Value
4757
+ * Make toolbar stick to edge of scroll container on supported browsers when scrolling (defaults to False).
4758
+ * @member {boolean} [Sticky=undefined]
6290
4759
  */
6291
- Value:string;
4760
+ Sticky?:boolean;
6292
4761
  }
6293
4762
  /**
6294
- * JSON object representing tag.
6295
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag DesignModeTagsOnResponseJsonTag]
4763
+ * Detachable configuration.
4764
+ * @class [Fit.Controls.InputTypeDefs.DesignModeDetachable DesignModeDetachable]
6296
4765
  */
6297
- class DesignModeTagsOnResponseJsonTag
4766
+ class DesignModeDetachable
6298
4767
  {
6299
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag
6300
- /**
6301
- * Optional context information to associate with tag.
6302
- * @member {string} [Context=undefined]
6303
- */
6304
- Context?:string;
4768
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeDetachable
6305
4769
  /**
6306
- * Optional context information to associate with tag.
6307
- * @member {string} [Context=undefined]
4770
+ * Flag indicating whether dialog is draggable.
4771
+ * @member {boolean} [Draggable=undefined]
6308
4772
  */
6309
- Context?:string;
4773
+ Draggable?:boolean;
6310
4774
  /**
6311
- * Optional data to associate with tag.
6312
- * @member {string} [Data=undefined]
4775
+ * Dialog height.
4776
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Height=undefined]
6313
4777
  */
6314
- Data?:string;
4778
+ Height?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6315
4779
  /**
6316
- * Optional data to associate with tag.
6317
- * @member {string} [Data=undefined]
4780
+ * Flag indicating whether dialog is maximizable.
4781
+ * @member {boolean} [Maximizable=undefined]
6318
4782
  */
6319
- Data?:string;
4783
+ Maximizable?:boolean;
6320
4784
  /**
6321
- * Optional URL to icon/image.
6322
- * @member {string} [Icon=undefined]
4785
+ * Flag indicating whether dialog is initially maximized.
4786
+ * @member {boolean} [Maximized=undefined]
6323
4787
  */
6324
- Icon?:string;
4788
+ Maximized?:boolean;
6325
4789
  /**
6326
- * Optional URL to icon/image.
6327
- * @member {string} [Icon=undefined]
4790
+ * Maximum height of dialog.
4791
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumHeight=undefined]
6328
4792
  */
6329
- Icon?:string;
4793
+ MaximumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6330
4794
  /**
6331
- * Title.
6332
- * @member {string} Title
4795
+ * Maximum Width of dialog.
4796
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MaximumWidth=undefined]
6333
4797
  */
6334
- Title:string;
4798
+ MaximumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6335
4799
  /**
6336
- * Title.
6337
- * @member {string} Title
4800
+ * Minimum height of dialog.
4801
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumHeight=undefined]
6338
4802
  */
6339
- Title:string;
4803
+ MinimumHeight?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6340
4804
  /**
6341
- * Optional URL to associate with tag.
6342
- * @member {string} [Url=undefined]
4805
+ * Minimum width of dialog.
4806
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [MinimumWidth=undefined]
6343
4807
  */
6344
- Url?:string;
4808
+ MinimumWidth?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6345
4809
  /**
6346
- * Optional URL to associate with tag.
6347
- * @member {string} [Url=undefined]
4810
+ * Flag indicating whether dialog is resizable.
4811
+ * @member {boolean} [Resizable=undefined]
6348
4812
  */
6349
- Url?:string;
4813
+ Resizable?:boolean;
6350
4814
  /**
6351
- * Unique value.
6352
- * @member {string} Value
4815
+ * Dialog title.
4816
+ * @member {string} [Title=undefined]
6353
4817
  */
6354
- Value:string;
4818
+ Title?:string;
6355
4819
  /**
6356
- * Unique value.
6357
- * @member {string} Value
4820
+ * Dialog width.
4821
+ * @member {{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" }} [Width=undefined]
6358
4822
  */
6359
- Value:string;
4823
+ Width?:{ Value: number, Unit?: Fit.TypeDefs.CssUnit | "%" | "ch" | "cm" | "em" | "ex" | "in" | "mm" | "pc" | "pt" | "px" | "rem" | "vh" | "vmax" | "vmin" | "vw" };
6360
4824
  }
6361
4825
  /**
6362
- * TagCreator event arguments.
6363
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs DesignModeTagsTagCreatorCallbackArgs]
4826
+ * Request handler event arguments.
4827
+ * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs DesignModeTagsOnRequestEventHandlerArgs]
6364
4828
  */
6365
- class DesignModeTagsTagCreatorCallbackArgs
4829
+ class DesignModeTagsOnRequestEventHandlerArgs
6366
4830
  {
6367
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs
6368
- /**
6369
- * Query marker.
6370
- * @member {string} QueryMarker
6371
- */
6372
- QueryMarker:string;
4831
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnRequestEventHandlerArgs
6373
4832
  /**
6374
- * Query marker.
6375
- * @member {string} QueryMarker
4833
+ * Query information.
4834
+ * @member {{ Marker: string, Query: string }} Query
6376
4835
  */
6377
- QueryMarker:string;
4836
+ Query:{ Marker: string, Query: string };
6378
4837
  /**
6379
- * Instance of control.
6380
- * @member {Fit.Controls.Input} Sender
4838
+ * Instance of JsonRequest or JsonpRequest.
4839
+ * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
6381
4840
  */
6382
- Sender:Fit.Controls.Input;
4841
+ Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
6383
4842
  /**
6384
4843
  * Instance of control.
6385
4844
  * @member {Fit.Controls.Input} Sender
6386
4845
  */
6387
4846
  Sender:Fit.Controls.Input;
6388
- /**
6389
- * Tag received from WebService.
6390
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag} Tag
6391
- */
6392
- Tag:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag;
6393
- /**
6394
- * Tag received from WebService.
6395
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag} Tag
6396
- */
6397
- Tag:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag;
6398
4847
  }
6399
4848
  /**
6400
- * TagCreator event arguments.
6401
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs DesignModeTagsTagCreatorCallbackArgs]
4849
+ * Response handler event arguments.
4850
+ * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs DesignModeTagsOnResponseEventHandlerArgs]
6402
4851
  */
6403
- class DesignModeTagsTagCreatorCallbackArgs
4852
+ class DesignModeTagsOnResponseEventHandlerArgs
6404
4853
  {
6405
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs
6406
- /**
6407
- * Query marker.
6408
- * @member {string} QueryMarker
6409
- */
6410
- QueryMarker:string;
4854
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseEventHandlerArgs
6411
4855
  /**
6412
- * Query marker.
6413
- * @member {string} QueryMarker
4856
+ * Query information.
4857
+ * @member {{ Marker: string, Query: string }} Query
6414
4858
  */
6415
- QueryMarker:string;
4859
+ Query:{ Marker: string, Query: string };
6416
4860
  /**
6417
- * Instance of control.
6418
- * @member {Fit.Controls.Input} Sender
4861
+ * Instance of JsonRequest or JsonpRequest.
4862
+ * @member {Fit.Http.JsonRequest | Fit.Http.JsonpRequest} Request
6419
4863
  */
6420
- Sender:Fit.Controls.Input;
4864
+ Request:Fit.Http.JsonRequest | Fit.Http.JsonpRequest;
6421
4865
  /**
6422
4866
  * Instance of control.
6423
4867
  * @member {Fit.Controls.Input} Sender
6424
4868
  */
6425
4869
  Sender:Fit.Controls.Input;
6426
4870
  /**
6427
- * Tag received from WebService.
6428
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag} Tag
6429
- */
6430
- Tag:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag;
6431
- /**
6432
- * Tag received from WebService.
6433
- * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag} Tag
4871
+ * Tags received from WebService.
4872
+ * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[]} Tags
6434
4873
  */
6435
- Tag:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag;
4874
+ Tags:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag[];
6436
4875
  }
6437
4876
  /**
6438
- * JSON object representing tag to be inserted into editor.
6439
- * @class [Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorReturnType DesignModeTagsTagCreatorReturnType]
4877
+ * JSON object representing tag.
4878
+ * @class [Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag DesignModeTagsOnResponseJsonTag]
6440
4879
  */
6441
- class DesignModeTagsTagCreatorReturnType
4880
+ class DesignModeTagsOnResponseJsonTag
6442
4881
  {
6443
- // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorReturnType
6444
- /**
6445
- * Optional tag context.
6446
- * @member {string} [Context=undefined]
6447
- */
6448
- Context?:string;
4882
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag
6449
4883
  /**
6450
- * Optional tag context.
4884
+ * Optional context information to associate with tag.
6451
4885
  * @member {string} [Context=undefined]
6452
4886
  */
6453
4887
  Context?:string;
6454
- /**
6455
- * Optional tag data.
6456
- * @member {string} [Data=undefined]
6457
- */
6458
- Data?:string;
6459
- /**
6460
- * Optional tag data.
6461
- * @member {string} [Data=undefined]
6462
- */
6463
- Data?:string;
6464
- /**
6465
- * Tag title.
6466
- * @member {string} Title
6467
- */
6468
- Title:string;
6469
- /**
6470
- * Tag title.
6471
- * @member {string} Title
6472
- */
6473
- Title:string;
6474
- /**
6475
- * Tag type (marker).
6476
- * @member {string} Type
4888
+ /**
4889
+ * Optional data to associate with tag.
4890
+ * @member {string} [Data=undefined]
6477
4891
  */
6478
- Type:string;
4892
+ Data?:string;
6479
4893
  /**
6480
- * Tag type (marker).
6481
- * @member {string} Type
4894
+ * Optional URL to icon/image.
4895
+ * @member {string} [Icon=undefined]
6482
4896
  */
6483
- Type:string;
4897
+ Icon?:string;
6484
4898
  /**
6485
- * Optional tag URL.
6486
- * @member {string} [Url=undefined]
4899
+ * Title.
4900
+ * @member {string} Title
6487
4901
  */
6488
- Url?:string;
4902
+ Title:string;
6489
4903
  /**
6490
- * Optional tag URL.
4904
+ * Optional URL to associate with tag.
6491
4905
  * @member {string} [Url=undefined]
6492
4906
  */
6493
4907
  Url?:string;
6494
4908
  /**
6495
- * Tag value (ID).
4909
+ * Unique value.
6496
4910
  * @member {string} Value
6497
4911
  */
6498
4912
  Value:string;
4913
+ }
4914
+ /**
4915
+ * TagCreator event arguments.
4916
+ * @class [Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs DesignModeTagsTagCreatorCallbackArgs]
4917
+ */
4918
+ class DesignModeTagsTagCreatorCallbackArgs
4919
+ {
4920
+ // Properties defined by Fit.Controls.InputTypeDefs.DesignModeTagsTagCreatorCallbackArgs
6499
4921
  /**
6500
- * Tag value (ID).
6501
- * @member {string} Value
4922
+ * Query marker.
4923
+ * @member {string} QueryMarker
6502
4924
  */
6503
- Value:string;
4925
+ QueryMarker:string;
4926
+ /**
4927
+ * Instance of control.
4928
+ * @member {Fit.Controls.Input} Sender
4929
+ */
4930
+ Sender:Fit.Controls.Input;
4931
+ /**
4932
+ * Tag received from WebService.
4933
+ * @member {Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag} Tag
4934
+ */
4935
+ Tag:Fit.Controls.InputTypeDefs.DesignModeTagsOnResponseJsonTag;
6504
4936
  }
6505
4937
  /**
6506
4938
  * JSON object representing tag to be inserted into editor.
@@ -6515,16 +4947,6 @@ declare namespace Fit
6515
4947
  */
6516
4948
  Context?:string;
6517
4949
  /**
6518
- * Optional tag context.
6519
- * @member {string} [Context=undefined]
6520
- */
6521
- Context?:string;
6522
- /**
6523
- * Optional tag data.
6524
- * @member {string} [Data=undefined]
6525
- */
6526
- Data?:string;
6527
- /**
6528
4950
  * Optional tag data.
6529
4951
  * @member {string} [Data=undefined]
6530
4952
  */
@@ -6535,16 +4957,6 @@ declare namespace Fit
6535
4957
  */
6536
4958
  Title:string;
6537
4959
  /**
6538
- * Tag title.
6539
- * @member {string} Title
6540
- */
6541
- Title:string;
6542
- /**
6543
- * Tag type (marker).
6544
- * @member {string} Type
6545
- */
6546
- Type:string;
6547
- /**
6548
4960
  * Tag type (marker).
6549
4961
  * @member {string} Type
6550
4962
  */
@@ -6555,16 +4967,6 @@ declare namespace Fit
6555
4967
  */
6556
4968
  Url?:string;
6557
4969
  /**
6558
- * Optional tag URL.
6559
- * @member {string} [Url=undefined]
6560
- */
6561
- Url?:string;
6562
- /**
6563
- * Tag value (ID).
6564
- * @member {string} Value
6565
- */
6566
- Value:string;
6567
- /**
6568
4970
  * Tag value (ID).
6569
4971
  * @member {string} Value
6570
4972
  */
@@ -10786,41 +9188,10 @@ declare namespace Fit
10786
9188
  {
10787
9189
  /** Do not allow resizing. */
10788
9190
  Disabled = "Disabled",
10789
- /** Do not allow resizing. */
10790
- Disabled = "Disabled",
10791
- /** Allow for resizing both vertically and horizontally. */
10792
- Enabled = "Enabled",
10793
- /** Allow for resizing both vertically and horizontally. */
10794
- Enabled = "Enabled",
10795
- /** Allow for horizontal resizing. */
10796
- Horizontal = "Horizontal",
10797
- /** Allow for horizontal resizing. */
10798
- Horizontal = "Horizontal",
10799
- /** Allow for vertical resizing. */
10800
- Vertical = "Vertical",
10801
- /** Allow for vertical resizing. */
10802
- Vertical = "Vertical"
10803
- }
10804
- /**
10805
- * Resizing options.
10806
- * @enum {string}
10807
- */
10808
- enum InputResizing
10809
- {
10810
- /** Do not allow resizing. */
10811
- Disabled = "Disabled",
10812
- /** Do not allow resizing. */
10813
- Disabled = "Disabled",
10814
- /** Allow for resizing both vertically and horizontally. */
10815
- Enabled = "Enabled",
10816
9191
  /** Allow for resizing both vertically and horizontally. */
10817
9192
  Enabled = "Enabled",
10818
9193
  /** Allow for horizontal resizing. */
10819
9194
  Horizontal = "Horizontal",
10820
- /** Allow for horizontal resizing. */
10821
- Horizontal = "Horizontal",
10822
- /** Allow for vertical resizing. */
10823
- Vertical = "Vertical",
10824
9195
  /** Allow for vertical resizing. */
10825
9196
  Vertical = "Vertical"
10826
9197
  }
@@ -10830,108 +9201,29 @@ declare namespace Fit
10830
9201
  */
10831
9202
  enum InputType
10832
9203
  {
10833
- /** Input control useful for entering a color. */
10834
- Color = "Color",
10835
- /** Input control useful for entering a color. */
10836
- Color = "Color",
10837
- /** Input control useful for entering a date. */
10838
- Date = "Date",
10839
- /** Input control useful for entering a date. */
10840
- Date = "Date",
10841
- /** Input control useful for entering a date and time. */
10842
- DateTime = "DateTime",
10843
- /** Input control useful for entering a date and time. */
10844
- DateTime = "DateTime",
10845
- /** Input control useful for entering an e-mail address. */
10846
- Email = "Email",
10847
- /** Input control useful for entering an e-mail address. */
10848
- Email = "Email",
10849
- /** Input control useful for entering a month. */
10850
- Month = "Month",
10851
- /** Input control useful for entering a month. */
10852
- Month = "Month",
10853
- /** Input control useful for entering a number. */
10854
- Number = "Number",
10855
- /** Input control useful for entering a number. */
10856
- Number = "Number",
10857
- /** Input control useful for entering a password (characters are masked). */
10858
- Password = "Password",
10859
- /** Input control useful for entering a password (characters are masked). */
10860
- Password = "Password",
10861
- /** Input control useful for entering a phone number. */
10862
- PhoneNumber = "PhoneNumber",
10863
- /** Input control useful for entering a phone number. */
10864
- PhoneNumber = "PhoneNumber",
10865
- /** Input control useful for entering ordinary text. */
10866
- Text = "Text",
10867
- /** Input control useful for entering ordinary text. */
10868
- Text = "Text",
10869
- /** Multi line input field. */
10870
- Textarea = "Textarea",
10871
- /** Multi line input field. */
10872
- Textarea = "Textarea",
10873
- /** Input control useful for entering time. */
10874
- Time = "Time",
10875
- /** Input control useful for entering time. */
10876
- Time = "Time",
10877
- /** Input control useful for entering a week number. */
10878
- Week = "Week",
10879
- /** Input control useful for entering a week number. */
10880
- Week = "Week"
10881
- }
10882
- /**
10883
- * Enum values determining input type.
10884
- * @enum {string}
10885
- */
10886
- enum InputType
10887
- {
10888
- /** Input control useful for entering a color. */
10889
- Color = "Color",
10890
9204
  /** Input control useful for entering a color. */
10891
9205
  Color = "Color",
10892
9206
  /** Input control useful for entering a date. */
10893
9207
  Date = "Date",
10894
- /** Input control useful for entering a date. */
10895
- Date = "Date",
10896
- /** Input control useful for entering a date and time. */
10897
- DateTime = "DateTime",
10898
9208
  /** Input control useful for entering a date and time. */
10899
9209
  DateTime = "DateTime",
10900
9210
  /** Input control useful for entering an e-mail address. */
10901
9211
  Email = "Email",
10902
- /** Input control useful for entering an e-mail address. */
10903
- Email = "Email",
10904
- /** Input control useful for entering a month. */
10905
- Month = "Month",
10906
9212
  /** Input control useful for entering a month. */
10907
9213
  Month = "Month",
10908
9214
  /** Input control useful for entering a number. */
10909
9215
  Number = "Number",
10910
- /** Input control useful for entering a number. */
10911
- Number = "Number",
10912
- /** Input control useful for entering a password (characters are masked). */
10913
- Password = "Password",
10914
9216
  /** Input control useful for entering a password (characters are masked). */
10915
9217
  Password = "Password",
10916
9218
  /** Input control useful for entering a phone number. */
10917
9219
  PhoneNumber = "PhoneNumber",
10918
- /** Input control useful for entering a phone number. */
10919
- PhoneNumber = "PhoneNumber",
10920
- /** Input control useful for entering ordinary text. */
10921
- Text = "Text",
10922
9220
  /** Input control useful for entering ordinary text. */
10923
9221
  Text = "Text",
10924
9222
  /** Multi line input field. */
10925
9223
  Textarea = "Textarea",
10926
- /** Multi line input field. */
10927
- Textarea = "Textarea",
10928
- /** Input control useful for entering time. */
10929
- Time = "Time",
10930
9224
  /** Input control useful for entering time. */
10931
9225
  Time = "Time",
10932
9226
  /** Input control useful for entering a week number. */
10933
- Week = "Week",
10934
- /** Input control useful for entering a week number. */
10935
9227
  Week = "Week"
10936
9228
  }
10937
9229
  /**
@@ -13056,8 +11348,9 @@ declare namespace Fit
13056
11348
  * @function IsSet
13057
11349
  * @static
13058
11350
  * @param {any} val - Object to validate.
11351
+ * @returns boolean
13059
11352
  */
13060
- public static IsSet(val:any):void;
11353
+ public static IsSet(val:any):boolean;
13061
11354
  /**
13062
11355
  * Throw error and provide stack trace to browser console.
13063
11356
  * @function ThrowError
@@ -13098,80 +11391,6 @@ declare namespace Fit
13098
11391
  * @static
13099
11392
  */
13100
11393
  static Skin:'bootstrapck' | 'moono-lisa' | null;
13101
- /**
13102
- * Skin used with DesignMode - must be set before an editor is created and cannot be changed for each individual control.
13103
- * @member {'bootstrapck' | 'moono-lisa' | null} Skin
13104
- * @static
13105
- */
13106
- static Skin:'bootstrapck' | 'moono-lisa' | null;
13107
- }
13108
- /**
13109
- * Internal settings related to HTML Editor (Design Mode).
13110
- * @class [Fit._internal.Controls.Input.Editor Editor]
13111
- */
13112
- class Editor
13113
- {
13114
- // Properties defined by Fit._internal.Controls.Input.Editor
13115
- /**
13116
- * Skin used with DesignMode - must be set before an editor is created and cannot be changed for each individual control.
13117
- * @member {'bootstrapck' | 'moono-lisa' | null} Skin
13118
- * @static
13119
- */
13120
- static Skin:'bootstrapck' | 'moono-lisa' | null;
13121
- /**
13122
- * Skin used with DesignMode - must be set before an editor is created and cannot be changed for each individual control.
13123
- * @member {'bootstrapck' | 'moono-lisa' | null} Skin
13124
- * @static
13125
- */
13126
- static Skin:'bootstrapck' | 'moono-lisa' | null;
13127
- }
13128
- }
13129
- /**
13130
- * Allows for manipulating control (appearance, features, and behaviour).
13131
- Features are NOT guaranteed to be backward compatible, and incorrect use might break control!.
13132
- * @namespace [Fit._internal.Controls.Input Input]
13133
- */
13134
- namespace Input
13135
- {
13136
- /**
13137
- * Internal settings related to HTML Editor (Design Mode).
13138
- * @class [Fit._internal.Controls.Input.Editor Editor]
13139
- */
13140
- class Editor
13141
- {
13142
- // Properties defined by Fit._internal.Controls.Input.Editor
13143
- /**
13144
- * Skin used with DesignMode - must be set before an editor is created and cannot be changed for each individual control.
13145
- * @member {'bootstrapck' | 'moono-lisa' | null} Skin
13146
- * @static
13147
- */
13148
- static Skin:'bootstrapck' | 'moono-lisa' | null;
13149
- /**
13150
- * Skin used with DesignMode - must be set before an editor is created and cannot be changed for each individual control.
13151
- * @member {'bootstrapck' | 'moono-lisa' | null} Skin
13152
- * @static
13153
- */
13154
- static Skin:'bootstrapck' | 'moono-lisa' | null;
13155
- }
13156
- /**
13157
- * Internal settings related to HTML Editor (Design Mode).
13158
- * @class [Fit._internal.Controls.Input.Editor Editor]
13159
- */
13160
- class Editor
13161
- {
13162
- // Properties defined by Fit._internal.Controls.Input.Editor
13163
- /**
13164
- * Skin used with DesignMode - must be set before an editor is created and cannot be changed for each individual control.
13165
- * @member {'bootstrapck' | 'moono-lisa' | null} Skin
13166
- * @static
13167
- */
13168
- static Skin:'bootstrapck' | 'moono-lisa' | null;
13169
- /**
13170
- * Skin used with DesignMode - must be set before an editor is created and cannot be changed for each individual control.
13171
- * @member {'bootstrapck' | 'moono-lisa' | null} Skin
13172
- * @static
13173
- */
13174
- static Skin:'bootstrapck' | 'moono-lisa' | null;
13175
11394
  }
13176
11395
  }
13177
11396
  }