diff --git a/types/devexpress-web/index.d.ts b/types/devexpress-web/index.d.ts
index 50aac382b1..9b29d9e0db 100644
--- a/types/devexpress-web/index.d.ts
+++ b/types/devexpress-web/index.d.ts
@@ -1,7 +1,11 @@
-// Type definitions for DevExpress ASP.NET v171.4
+// Type definitions for DevExpress ASP.NET v172.6
// Project: http://devexpress.com/
// Definitions by: DevExpress Inc.
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+// TypeScript Version: 2.3
+
+///
+///
/**
* A client-side counterpart of the DashboardViewer extension.
@@ -115,7 +119,7 @@ interface ASPxClientDashboardItemClickEventArgs extends ASPxClientEventArgs {
/**
* Requests underlying data corresponding to the clicked visual element.
* @param onCompleted A ASPxClientDashboardItemRequestUnderlyingDataCompleted object that references a method executed after the request is completed.
- * @param dataMembers An array of string values that specify data members used to obtain underlying data.
+ * @param dataMembers (Optional) An array of string values that specify data members used to obtain underlying data. If this parameter is not specified, underlying data for all available data members will be requested.
*/
RequestUnderlyingData(onCompleted: ASPxClientDashboardItemRequestUnderlyingDataCompleted, dataMembers: string[]): void;
}
@@ -550,6 +554,53 @@ interface ASPxClientDashboardItemDataDeltaValue {
*/
GetIndicatorType(): ASPxClientDashboardItemDataMeasureValue;
}
+/**
+ * References a method that will handle the ItemCaptionToolbarUpdated event.
+ */
+interface ASPxClientDashboardItemCaptionToolbarUpdatedEventHandler {
+ /**
+ * References a method that will handle the ItemCaptionToolbarUpdated event.
+ * @param source The event source.
+ * @param e The ASPxClientDashboardItemCaptionToolbarUpdatedEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardItemCaptionToolbarUpdatedEventArgs): void;
+}
+/**
+ * Provides data for the ItemCaptionToolbarUpdated event.
+ */
+interface ASPxClientDashboardItemCaptionToolbarUpdatedEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets a component name of the dashboard item.
+ * Value: A string value that is a component name of the dashboard item.
+ */
+ ItemName: string;
+ /**
+ * Provides access to caption options of the dashboard item.
+ * Value: A DashboardItemCaptionToolbarOptions object containing caption options of the dashboard item.
+ */
+ Options: Object;
+}
+/**
+ * References a method that will handle the DashboardTitleToolbarUpdated event.
+ */
+interface ASPxClientDashboardTitleToolbarUpdatedEventHandler {
+ /**
+ * References a method that will handle the DashboardTitleToolbarUpdated event.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardTitleToolbarUpdatedEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardTitleToolbarUpdatedEventArgs): void;
+}
+/**
+ * Provides data for the DashboardTitleToolbarUpdated event.
+ */
+interface ASPxClientDashboardTitleToolbarUpdatedEventArgs extends ASPxClientEventArgs {
+ /**
+ * Provides access to dashboard title options.
+ * Value: A DashboardTitleToolbarOptions object containing dashboard title options.
+ */
+ Options: Object;
+}
/**
* A point on the data axis.
*/
@@ -945,6 +996,16 @@ interface DashboardPdfExportOptions {
* Value: A DashboardExportScaleMode value that specifies the mode for scaling a dashboard/dashboard item in the exported document.
*/
ScaleMode: string;
+ /**
+ * Gets or sets the mode for scaling a dashboard/dashboard item in the exported document.
+ * Value: A DashboardExportDocumentScaleMode value that specifies the mode for scaling a dashboard/dashboard item in the exported document.
+ */
+ DocumentScaleMode: string;
+ /**
+ * Gets or sets whether the page orientation used to export a dashboard is selected automatically.
+ * Value: true, to automatically select the page orientation used to export a dashboard; otherwise, false.
+ */
+ DashboardAutomaticPageLayout: boolean;
/**
* Gets or sets the scale factor (in fractions of 1), by which a dashboard/dashboard item is scaled in the exported document.
* Value: A Single value that specifies the scale factor by which a dashboard/dashboard item is scaled in the exported document.
@@ -1232,6 +1293,30 @@ interface ASPxClientDashboard extends ASPxClientControl {
* Occurs after the dashboard update is performed.
*/
DashboardEndUpdate: ASPxClientEvent>;
+ /**
+ * Allows you to customize a dashboard item's caption (for instance, add custom buttons, menus, etc.).
+ */
+ ItemCaptionToolbarUpdated: ASPxClientEvent>;
+ /**
+ * Allows you to customize a dashboard title (for instance, add custom buttons, menus, etc.).
+ */
+ DashboardTitleToolbarUpdated: ASPxClientEvent>;
+ /**
+ * Returns names of the predefined ranges available for the specified Range Filter.
+ * @param itemName A string value that specifies the component name of the Range Filter dashboard item.
+ */
+ GetAvailablePredefinedRanges(itemName: string): string[];
+ /**
+ * Returns the name of the currently selected predefined range.
+ * @param itemName A string value that specifies the component name of the Range Filter dashboard item.
+ */
+ GetCurrentPredefinedRange(itemName: string): string;
+ /**
+ *
+ * @param itemName
+ */
+ UpdateItemCaptionToolbar(itemName: string): void;
+ UpdateDashboardTitleToolbar(): void;
/**
* Sends a callback to the server and generates the server-side CustomDataCallback event, passing it the specified argument.
* @param parameter A string value that represents any information that needs to be sent to the server-side CustomDataCallback event.
@@ -1239,7 +1324,7 @@ interface ASPxClientDashboard extends ASPxClientControl {
*/
PerformDataCallback(parameter: string, onCallback: ASPxClientDataCallback): void;
/**
- * Gets an inner part of the ASPxClientDashboard control.
+ * Gets the DashboardControl object that is the client-side part of the Web Dashboard.
*/
GetDashboardControl(): DashboardControl;
/**
@@ -1299,7 +1384,7 @@ interface ASPxClientDashboard extends ASPxClientControl {
GetParameters(): ASPxClientDashboardParameters;
/**
* Invokes the dialog that allows end-users to export the entire dashboard to the specified format.
- * @param format A string value that specifies the format. For instance, you can use 'PDF' or 'Image'.
+ * @param format A string value that specifies the format. For instance, you can use 'PDF', 'Image', or 'Excel'.
*/
ShowExportDashboardDialog(format: string): void;
/**
@@ -1635,16 +1720,6 @@ interface ASPxClientDashboard extends ASPxClientControl {
* @param dateTimePeriodName A String value that specifies the predefined range name.
*/
SetPredefinedRange(itemName: string, dateTimePeriodName: string): void;
- /**
- * Returns names of the predefined ranges available for the specified Range Filter.
- * @param itemName A string value that specifies the component name of the Range Filter dashboard item.
- */
- GetAvailablePredefinedRanges(itemName: string): string[];
- /**
- * Returns the name of the currently selected predefined range.
- * @param itemName A string value that specifies the component name of the Range Filter dashboard item.
- */
- GetCurrentPredefinedRange(itemName: string): string;
}
/**
* References a method that will handle the DashboardStateChanged event.
@@ -1986,6 +2061,14 @@ interface ASPxClientDashboardViewer extends ASPxClientControl {
* Allows you to color the required dashboard item elements using the specified colors.
*/
ItemElementCustomColor: ASPxClientEvent>;
+ /**
+ * Allows you to customize a dashboard item's caption (for instance, add custom buttons, menus, etc.).
+ */
+ ItemCaptionToolbarUpdated: ASPxClientEvent>;
+ /**
+ * Allows you to customize a dashboard title (for instance, add custom buttons, menus, etc.).
+ */
+ TitleToolbarUpdated: ASPxClientEvent>;
/**
* Reloads data in the data sources.
*/
@@ -2064,6 +2147,12 @@ interface ASPxClientDashboardViewer extends ASPxClientControl {
* @param itemName A String that specifies a component name of the master filter item.
*/
GetCurrentSelection(itemName: string): ASPxClientDashboardItemDataAxisPointTuple[];
+ /**
+ *
+ * @param itemName
+ */
+ UpdateItemCaptionToolbar(itemName: string): void;
+ UpdateDashboardTitleToolbar(): void;
/**
* Requests underlying data for the specified dashboard item.
* @param itemName A string that specifies the component name of the dashboard item.
@@ -2079,6 +2168,21 @@ interface ASPxClientDashboardViewer extends ASPxClientControl {
* Closes the Dashboard Parameters dialog.
*/
HideParametersDialog(): void;
+ /**
+ * Shows the dialog that allows end-users to export the dashboard.
+ * @param format A string value that specifies the format. For instance, you can use 'PDF, 'Image' or 'Excel'.
+ */
+ ShowExportDialog(format: string): void;
+ /**
+ * Shows the dialog that allows end-users to export the dashboard item.
+ * @param itemComponentName A component name of the dashboard item.
+ * @param format A string value that specifies the format. For instance, you can use 'PDF, 'Image' or 'Excel'.
+ */
+ ShowExportDashboardItemDialog(itemComponentName: string, format: string): void;
+ /**
+ * Hides the dialog that allows end-users to export the dashboard/dashboard item.
+ */
+ HideExportDialog(): void;
/**
* Returns settings that specify parameters affecting how the dashboard is exported.
*/
@@ -2554,8 +2658,17 @@ interface ASPxClientDashboardDrillUpPerformedEventArgs extends ASPxClientEventAr
*/
ItemName: string;
}
+/**
+ * Provides data for the onCustomizeText handler.
+ */
interface CardWidgetCustomizeTextEventArgs {
+ /**
+ * Gets a dimension/measure value to be displayed within the card.
+ */
getValue(): Object;
+ /**
+ * Gets a formatted value displayed within the card.
+ */
getDefaultText(): string;
}
/**
@@ -2567,7 +2680,15 @@ interface CardWidget {
* Value: A string that specifies the HTML color used to paint a card's background.
*/
cardBackColor: string;
+ /**
+ * Allows you to customize texts displayed within individual cards.
+ * Value: A handler used customize texts displayed within individual cards.
+ */
onCustomizeText: Object;
+ /**
+ * Gets the root element of the widget.
+ */
+ element(): Object;
}
/**
* When implemented, represents the Web Dashboard extension.
@@ -2588,14 +2709,14 @@ interface IExtension {
stop(): void;
}
/**
- * An inner part of the ASPxClientDashboard control.
+ * A client-side part of the Web Dashboard.
*/
interface DashboardControl {
/**
* Gets or sets knockout templates that you can use in the Web Dashboard.
* Value: A object that is a knockout template collection.
*/
- customTemplates: KnockoutObservableArray;
+ customTemplates: KnockoutObservableArray;
/**
* Provides an access to the collection of registered dashboard extensions.
* Value: An array of IExtension objects that are dashboard extensions.
@@ -2630,11 +2751,60 @@ interface DashboardControl {
*/
unregisterExtension(extensionName: string): void;
}
+interface UrlStateExtension extends IExtension {
+}
+interface Element {
+}
+/**
+ * The content of the Dashboard Parameters dialog.
+ */
+interface ParameterDialogContent {
+ /**
+ * Gets the Dashboard Parameters dialog's grid that displays parameter values.
+ * Value: The Dashboards Parameters dialog's grid that displays parameter values.
+ */
+ grid: Object;
+ /**
+ * Applies changes made in the Dashboard Parameters dialog.
+ */
+ submitParameterValues(): void;
+ /**
+ * Resets changes in the Dashboard Parameters dialog to the default values.
+ */
+ resetParameterValues(): void;
+ valueChanged(): void;
+}
+/**
+ * A Web Dashboard extension that is the Dashboard Parameters dialog.
+ */
interface DashboardParameterDialogExtension extends IExtension {
+ /**
+ * Gets or sets whether to show the Dashboard Parameters button in the dashboard title.
+ * Value: true, to show the Dashboard Parameters button; otherwise, false.
+ */
+ showDialogButton: KnockoutObservableBoolean;
+ /**
+ * Invokes the Dashboard Parameters dialog.
+ */
+ show(): void;
+ /**
+ * Closes the Dashboard Parameters dialog.
+ */
+ hide(): void;
+ /**
+ * Allows you to be notified about the dashboard parameter settings changes.
+ * @param callback A custom function.
+ */
+ subscribeToContentChanges(callback: Function): Object;
+ /**
+ * Renders the content of the Dashboard Parameters dialog inside the specified JQuery element.
+ * @param element A JQuery element where the Dashboard Parameters dialog content is rendered.
+ */
+ renderContent(element: Element): ParameterDialogContent;
}
interface DashboardExportExtension extends IExtension {
}
-interface DashboardClientApiExtension extends IExtension {
+interface ViewerApiExtension extends IExtension {
}
interface DashboardCurrencyEditorExtension extends IExtension {
}
@@ -2642,7 +2812,12 @@ interface DataSourceBrowserExtension extends IExtension {
}
interface DataSourceWizardExtension extends IExtension {
}
-interface DashboadItemMenuExtension extends IExtension {
+interface DashboardItemMenuExtension extends IExtension {
+}
+/**
+ * A Web Dashboard extension that allows you to configure color schemes.
+ */
+interface DashboardColorSchemeEditorExtension extends IExtension {
}
/**
* A Web Dashboard extension that allows you to keep track of all user actions, and cancel or repeat them.
@@ -2654,17 +2829,12 @@ interface UndoRedoExtension extends IExtension {
isChanged(): boolean;
}
/**
- * An extension that is the dashboard item's Binding menu allowing you to create and modify data binding.
+ * A Web Dashboard extension that is the dashboard item's Binding menu allowing you to create and modify data binding.
*/
interface BindingPanelExtension extends IExtension {
}
/**
- * A Web Dashboard extension that allows you to configure color schemes.
- */
-interface DashboardColorSchemeEditorExtension extends IExtension {
-}
-/**
- * An extension that is the dashboard item's Convert To menu allowing you to convert or duplicate the current item.
+ * A Web Dashboard extension that is the dashboard item's Convert To menu allowing you to convert or duplicate the current item.
*/
interface ConversionPanelExtension extends IExtension {
}
@@ -2710,22 +2880,22 @@ interface OpenDashboardExtension extends IExtension {
loadDashboard(id: string): void;
}
/**
- * An extension that is the dashboard item's Interactivity menu containing settings that affect on interaction between various dashboard items.
+ * A Web Dashboard extension that is the dashboard item's Interactivity menu containing settings that affect on interaction between various dashboard items.
*/
interface InteractivityPanelExtension extends IExtension {
}
/**
- * An extension that is the dashboard item's Options menu containing specific options and settings related to the current dashboard item.
+ * A Web Dashboard extension that is the dashboard item's Options menu containing specific options and settings related to the current dashboard item.
*/
interface OptionsPanelExtension extends IExtension {
}
/**
- * An extension that is the Web Dashboard title editor.
+ * A Web Dashboard extension that is the dashboard title editor.
*/
interface DashboardTitleEditorExtension extends IExtension {
}
/**
- * The Dashboard Panel extension that displays a list of available dashboards and lets you switch between the designer and viewer modes.
+ * The Dashboard Panel extension that allows users to switch between dashboards and enable the Designer mode.
*/
interface DashboardPanelExtension extends IExtension {
/**
@@ -2894,10 +3064,10 @@ interface DashboardToolboxGroup {
*/
index: number;
/**
- * Provide an access to the collection of toolbox items obtained from the specified toolbox group.
- * Value: A object that is an array of items obtained from the specified toolbox group.
+ * Provides access to a collection of toolbox group items.
+ * Value: A DashboardToolboxItem).
*/
- items: KnockoutObservableArray;
+ items: KnockoutObservableArray;
}
/**
* A toolbar group that contains dashboard toolbar items.
@@ -2919,35 +3089,34 @@ interface DashboardToolbarGroup {
*/
index: number;
/**
- * Provide an access to the collection of toolbox items obtained from the specified toolbar group.
- * Value: A object that is an array of items obtained from the specified toolbar group.
+ * Provides access to a collection of toolbar group items.
+ * Value: A DashboardToolbarItem).
*/
- items: KnockoutObservableArray;
+ items: KnockoutObservableArray;
}
/**
* The Web Dashboard Toolbox extension that provides access to the dashboard menu and allows you to add dashboard items, as well as undo or repeat user actions.
*/
interface ToolboxExtension extends IExtension {
/**
- * Gets or sets the visibility of the dashboard menu.
- * Value: true, to display the dashboard menu; otherwise, false.
+ * Provides access to a collection of the dashboard menu items.
+ * Value: A DashboardMenuItem).
+ */
+ menuItems: KnockoutObservableArray;
+ /**
+ * Provides access to a collection of the Toolbox groups.
+ * Value: A DashboardToolboxGroup).
+ */
+ toolboxGroups: KnockoutObservableArray;
+ /**
+ * Provides access to a collection of toolbar groups from the Toolbox.
+ * Value: A DashboardToolbarGroup).
+ */
+ toolbarGroups: KnockoutObservableArray;
+ /**
+ * For internal use.
*/
menuVisible: KnockoutObservableBoolean;
- /**
- * Provide an access to the collection of menu items obtained from the dashboard menu.
- * Value: A object that is a collection the dashboard menu items .
- */
- menuItems: KnockoutObservableArray;
- /**
- * Provide an access to the collection of toolbox groups obtained from the Toolbox.
- * Value: A object that is a collection the toolbox groups.
- */
- toolboxGroups: KnockoutObservableArray;
- /**
- * Provide an access to the collection of toolbar groups obtained from the Toolbox.
- * Value: A object that is a collection the toolbar groups.
- */
- toolbarGroups: KnockoutObservableArray;
/**
* Allows you to add a specified menu item to the dashboard menu.
* @param menuItem A DashboardMenuItem object that is a dashboard menu item.
@@ -2970,9 +3139,9 @@ interface ToolboxExtension extends IExtension {
*/
addToolboxItem(groupName: string, toolboxItem: DashboardToolboxItem): void;
/**
- * Removes the specified toolbox item from the specified toolbox group.
- * @param groupName A string value that is a unique toolbox group name.
- * @param toolboxItemName A string value that is a unique toolbox item name.
+ * Removes the specified item from the specified toolbox group.
+ * @param groupName A string value that is a unique toolbox group name (name).
+ * @param toolboxItemName A string value that is a unique toolbox item name (name).
*/
removeToolboxItem(groupName: string, toolboxItemName: string): void;
/**
@@ -3438,6 +3607,10 @@ interface ASPxClientTextEdit extends ASPxClientEdit {
* Fires on the client side when the editor's text is changed and focus moves out of the editor by end-user interactions.
*/
TextChanged: ASPxClientEvent>;
+ /**
+ * Fires on the client side when the editor's input value is changed before the focus moves out of the editor by end-user interactions.
+ */
+ UserInput: ASPxClientEvent>;
/**
* Returns the text displayed within the editor.
*/
@@ -4249,7 +4422,7 @@ interface ASPxClientListBox extends ASPxClientListEdit {
*/
PerformCallback(parameter: string): void;
/**
- * Adds a new item to the end of the editor's items collection, specifying the item's display text, and returns the index of the added item.
+ * Adds a new item to the editor, specifying the item's display text, and returns the added item's index.
* @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding columns within the editor's Columns collection.
*/
AddItem(texts: string[]): number;
@@ -5021,6 +5194,11 @@ interface ASPxClientGridBase extends ASPxClientControl {
*/
interface ASPxClientGridColumnBase {
}
+/**
+ * Lists values that specify the document formats available for export from the grid.
+ */
+interface ASPxClientGridExportFormat {
+}
/**
* A method that will handle the ToolbarItemClick event.
*/
@@ -5047,8 +5225,8 @@ interface ASPxClientGridToolbarItemClickEventArgs extends ASPxClientProcessingMo
*/
toolbarName: string;
/**
- * Gets the clicked toolbar item.
- * Value: A ASPxClientMenuItem object that is the toolbar item.
+ * Gets the clicked menu item
+ * Value: An ASPxClientMenu value that is the menu item.
*/
item: ASPxClientMenuItem;
/**
@@ -5158,7 +5336,11 @@ interface ASPxClientCardView extends ASPxClientGridBase {
/**
* Fires in response to changing card focus.
*/
- FocusedCardChanged: ASPxClientEvent>;
+ FocusedCardChanged: ASPxClientEvent>;
+ /**
+ * Fires before a card has been focused.
+ */
+ CardFocusing: ASPxClientEvent>;
/**
* Occurs when a callback for server-side processing is initiated.
*/
@@ -5175,6 +5357,21 @@ interface ASPxClientCardView extends ASPxClientGridBase {
* Fires after the customization window has been closed.
*/
CustomizationWindowCloseUp: ASPxClientEvent>;
+ /**
+ * Returns the editor used to edit the specified column's values.
+ * @param column An ASPxClientCardViewColumn object that specifies the required column within the client grid.
+ */
+ GetEditor(column: ASPxClientCardViewColumn): ASPxClientEdit;
+ /**
+ * Returns the editor used to edit the specified column's values.
+ * @param columnIndex An integer value that specifies the column's position within the column collection.
+ */
+ GetEditor(columnIndex: number): ASPxClientEdit;
+ /**
+ * Returns the editor used to edit the specified column's values.
+ * @param columnFieldNameOrId A string value that specifies the column's field name or unique identifier (the column's Name property value).
+ */
+ GetEditor(columnFieldNameOrId: string): ASPxClientEdit;
/**
* Returns the value of the specified edit cell.
* @param column An ASPxClientCardViewColumn object that represents the data column within the client grid.
@@ -5255,6 +5452,11 @@ interface ASPxClientCardView extends ASPxClientGridBase {
* @param columnIndex A zero-based index that identifies the column in the column collection (the column's Index property value).
*/
SetFocusedCell(cardVisibleIndex: number, columnIndex: number): void;
+ /**
+ * Specifies a custom editor for the search panel on the client side.
+ * @param editor An ASPxClientEdit object representing a custom editor.
+ */
+ SetSearchPanelCustomEditor(editor: ASPxClientEdit): void;
/**
* Sorts data by the specified data column's values.
* @param column An ASPxClientCardViewColumn object that represents the data column.
@@ -5407,7 +5609,7 @@ interface ASPxClientCardView extends ASPxClientGridBase {
*/
IsNewCardEditing(): boolean;
/**
- * Adds a new record.
+ * Adds a new card.
*/
AddNewCard(): void;
/**
@@ -5543,6 +5745,11 @@ interface ASPxClientCardView extends ASPxClientGridBase {
* @param visibleIndex An integer value that identifies the card by its visible index.
*/
IsCardSelectedOnPage(visibleIndex: number): boolean;
+ /**
+ * Exports a grid data to a file in the specified format.
+ * @param format An ASPxClientCardViewExportFormat object specifying the export format.
+ */
+ ExportTo(format: ASPxClientCardViewExportFormat): void;
/**
* Applies the specified search panel filter criterion to grid data.
* @param value A string value that specifies the filter criterion.
@@ -5682,25 +5889,10 @@ interface ASPxClientCardView extends ASPxClientGridBase {
*/
GetColumnById(columnId: string): ASPxClientCardViewColumn;
/**
- * Returns the client column which is bound to the specified data source field.
+ * Returns the client column to which the specified data source field is bound.
* @param columnFieldName A string value that specifies the name of the data source field to which the column is bound (the column's FieldName property value).
*/
GetColumnByField(columnFieldName: string): ASPxClientCardViewColumn;
- /**
- * Returns the editor used to edit the specified column's values.
- * @param column An ASPxClientCardViewColumn object that specifies the required column within the client grid.
- */
- GetEditor(column: ASPxClientCardViewColumn): ASPxClientEdit;
- /**
- * Returns the editor used to edit the specified column's values.
- * @param columnIndex An integer value that specifies the column's position within the column collection.
- */
- GetEditor(columnIndex: number): ASPxClientEdit;
- /**
- * Returns the editor used to edit the specified column's values.
- * @param columnFieldNameOrId A string value that specifies the column's field name or unique identifier (the column's Name property value).
- */
- GetEditor(columnFieldNameOrId: string): ASPxClientEdit;
}
/**
* Represents a client column.
@@ -5758,6 +5950,32 @@ interface ASPxClientCardViewColumnCancelEventArgs extends ASPxClientCancelEventA
*/
column: ASPxClientCardViewColumn;
}
+/**
+ * A method that will handle the client CardFocusing event.
+ */
+interface ASPxClientCardViewCardFocusingEventHandler {
+ /**
+ * Represents a method that will handle the CardFocusing event.
+ * @param source The event source.
+ * @param e An ASPxClientCardViewCardFocusingEventArgs object which contains event data.
+ */
+ (source: S, e: ASPxClientCardViewCardFocusingEventArgs): void;
+}
+/**
+ * Provides data for the CardFocusing event.
+ */
+interface ASPxClientCardViewCardFocusingEventArgs extends ASPxClientCancelEventArgs {
+ /**
+ * Gets the card visible index.
+ * Value: An integer value specifying the visible index.
+ */
+ visibleIndex: number;
+ /**
+ * Provides access to the parameters associated with the CardFocusing event.
+ * Value: An object that contains parameters associated with the event.
+ */
+ htmlEvent: Object;
+}
/**
* A method that will handle the CardClick event.
*/
@@ -5846,6 +6064,27 @@ interface ASPxClientCardViewSelectionEventArgs extends ASPxClientProcessingModeE
*/
isChangedOnServer: boolean;
}
+/**
+ * A method that will handle the client FocusedCardChanged event.
+ */
+interface ASPxClientCardViewFocusEventHandler {
+ /**
+ * Represents a method that will handle the FocusedCardChanged event.
+ * @param source The event source.
+ * @param e An ASPxClientCardViewFocusEventArgs object which contains event data.
+ */
+ (source: S, e: ASPxClientCardViewFocusEventArgs): void;
+}
+/**
+ * Provides data for the corresponding event.
+ */
+interface ASPxClientCardViewFocusEventArgs extends ASPxClientProcessingModeEventArgs {
+ /**
+ * Gets whether card focusing has been changed on the server.
+ * Value: true , if the card focusing has been changed on the server; otherwise, false.
+ */
+ isChangedOnServer: boolean;
+}
/**
* A method that will handle the client BatchEditStartEditing event.
*/
@@ -6143,6 +6382,30 @@ interface ASPxClientCardViewBatchEditApi {
* @param visibleIndex An integer value that identifies the card by its visible index.
*/
IsNewCard(visibleIndex: number): boolean;
+ /**
+ * Adds a new card when ASPxCardView is in Batch Edit mode.
+ */
+ AddNewCard(): void;
+ /**
+ * Deletes the specified card when ASPxCardView is in Batch Edit mode.
+ * @param visibleIndex An integer value that identifies the card index.
+ */
+ DeleteCard(visibleIndex: number): void;
+ /**
+ * Deletes a card with a specified key value when ASPxCardView is in Batch Edit mode.
+ * @param key An object that uniquely identifies the card.
+ */
+ DeleteCardByKey(key: Object): void;
+ /**
+ * Recovers the specified card when ASPxCardView is in Batch Edit mode.
+ * @param visibleIndex An integer value that identifies the card index.
+ */
+ RecoverCard(visibleIndex: number): void;
+ /**
+ * Recovers a card with a specified key value when ASPxCardView is in Batch Edit mode.
+ * @param key An object that uniquely identifies the card.
+ */
+ RecoverCardByKey(key: Object): void;
/**
* Programmatically moves the focus to the previous cell in the card
*/
@@ -6220,6 +6483,12 @@ interface ASPxClientCardViewBatchEditApi {
* Ends cell or card editing.
*/
EndEdit(): void;
+ /**
+ * Provides the text displayed within the cell according to the specified display format rule.
+ * @param columnFieldNameOrId A string value representing the column's unique identifier or field name.
+ * @param value An object representing a value.
+ */
+ GetColumnDisplayText(columnFieldNameOrId: string, value: Object): string;
}
/**
* Contains information on a grid cell.
@@ -6236,6 +6505,11 @@ interface ASPxClientCardViewCellInfo {
*/
column: ASPxClientCardViewColumn;
}
+/**
+ * Lists values that specify the document formats available for export from the grid.
+ */
+interface ASPxClientCardViewExportFormat extends ASPxClientGridExportFormat {
+}
/**
* A client-side equivalent of the ASPxGridView object.
*/
@@ -6260,7 +6534,11 @@ interface ASPxClientGridView extends ASPxClientGridBase {
/**
* Fires in response to changing row focus.
*/
- FocusedRowChanged: ASPxClientEvent>;
+ FocusedRowChanged: ASPxClientEvent>;
+ /**
+ * Fires before a row has been focused.
+ */
+ RowFocusing: ASPxClientEvent>;
/**
* Enables you to cancel data grouping.
*/
@@ -6369,6 +6647,29 @@ interface ASPxClientGridView extends ASPxClientGridBase {
* Fires after the Customization Window has been closed.
*/
CustomizationWindowCloseUp: ASPxClientEvent>;
+ /**
+ * Selects the specified rows within the grid.
+ * @param visibleIndices An array of zero-based indices that identify data rows within the grid.
+ */
+ SelectRows(visibleIndices: number[]): void;
+ /**
+ * Selects or deselects the specified rows within the grid.
+ * @param visibleIndices An array of zero-based indices that identify data rows within the grid.
+ * @param selected true to select the specified rows; false to deselect the rows.
+ */
+ SelectRows(visibleIndices: number[], selected: boolean): void;
+ /**
+ * Selects or deselects the specified row within the grid.
+ * @param visibleIndex An integer zero-based index that identifies the data row within the grid.
+ * @param selected true to select the specified row; false to deselect the row.
+ */
+ SelectRows(visibleIndex: number, selected?: boolean): void;
+ /**
+ * Selects or deselects the specified rows displayed within the grid.
+ * @param keys An array of objects that uniquely identify the rows.
+ * @param selected true to select the specified rows; false to deselect the rows.
+ */
+ SelectRowsByKey(keys: Object[], selected?: boolean): void;
/**
* Selects or deselects the specified row displayed within the grid.
* @param key An object that uniquely identifies the row.
@@ -6498,6 +6799,16 @@ interface ASPxClientGridView extends ASPxClientGridBase {
* @param scrollableRowSettings An object specifying which types of grid rows should or should not be scrollable.
*/
SetFixedColumnScrollableRows(scrollableRowSettings: Object): void;
+ /**
+ * Exports a grid data to a file in the specified format.
+ * @param format An ASPxClientGridViewExportFormat object specifying the export format.
+ */
+ ExportTo(format: ASPxClientGridViewExportFormat): void;
+ /**
+ * Returns a value specifying the indices of the rows visible in the browser's view port.
+ * @param includePartiallyVisible true, to include partially visible rows, otherwise, false.
+ */
+ GetRowIndicesVisibleInViewPort(includePartiallyVisible: boolean): number[];
/**
* Applies a filter specified in the filter row to the GridView.
*/
@@ -6777,6 +7088,11 @@ interface ASPxClientGridView extends ASPxClientGridBase {
* @param columnIndex A zero-based index that identifies the column in the column collection (the column's Index property value).
*/
SetFocusedCell(rowVisibleIndex: number, columnIndex: number): void;
+ /**
+ * Specifies a custom editor for the search panel on the client side.
+ * @param editor An ASPxClientEdit object representing a custom editor.
+ */
+ SetSearchPanelCustomEditor(editor: ASPxClientEdit): void;
/**
* Invokes the Customization Dialog and displays it over the grid.
*/
@@ -6996,6 +7312,15 @@ interface ASPxClientGridView extends ASPxClientGridBase {
* @param moveFromGroup true, to ungroup the grid's data by the column; otherwise, false.
*/
MoveColumn(columnFieldNameOrId: string, moveToColumnVisibleIndex: number, targetPosition: ASPxClientGridColumnMovingTargetPosition, moveToGroup: boolean, moveFromGroup: boolean): void;
+ /**
+ * Returns an object specifying the grid column's layout.
+ */
+ GetColumnLayout(): Object;
+ /**
+ * Specifies the grid column's layout.
+ * @param columnLayout An object specifying the grid column's layout.
+ */
+ SetColumnLayout(columnLayout: Object): void;
/**
* Groups data by the values of the specified column.
* @param column An ASPxClientGridViewColumn object that represents the data column by whose values data is grouped.
@@ -7184,29 +7509,6 @@ interface ASPxClientGridView extends ASPxClientGridBase {
* @param visibleIndex A zero-based integer value that specifies the row's visible index.
*/
SelectRows(visibleIndex: number): void;
- /**
- * Selects the specified rows within the grid.
- * @param visibleIndices An array of zero-based indices that identify data rows within the grid.
- */
- SelectRows(visibleIndices: number[]): void;
- /**
- * Selects or deselects the specified rows within the grid.
- * @param visibleIndices An array of zero-based indices that identify data rows within the grid.
- * @param selected true to select the specified rows; false to deselect the rows.
- */
- SelectRows(visibleIndices: number[], selected: boolean): void;
- /**
- * Selects or deselects the specified row within the grid.
- * @param visibleIndex An integer zero-based index that identifies the data row within the grid.
- * @param selected true to select the specified row; false to deselect the row.
- */
- SelectRows(visibleIndex: number, selected?: boolean): void;
- /**
- * Selects or deselects the specified rows displayed within the grid.
- * @param keys An array of objects that uniquely identify the rows.
- * @param selected true to select the specified rows; false to deselect the rows.
- */
- SelectRowsByKey(keys: Object[], selected?: boolean): void;
}
/**
* A client grid column.
@@ -7347,6 +7649,48 @@ interface ASPxClientGridViewSelectionEventArgs extends ASPxClientProcessingModeE
*/
isChangedOnServer: boolean;
}
+/**
+ * A method that will handle the client FocusedRowChanged event.
+ */
+interface ASPxClientGridViewFocusEventHandler {
+ /**
+ * Represents a method that will handle the FocusedRowChanged event.
+ * @param source The event source.
+ * @param e An ASPxClientGridViewFocusEventArgs object which contains event data.
+ */
+ (source: S, e: ASPxClientGridViewFocusEventArgs): void;
+}
+/**
+ * Provides data for the corresponding event.
+ */
+interface ASPxClientGridViewFocusEventArgs extends ASPxClientProcessingModeEventArgs {
+ /**
+ * Gets whether the row focusing has been changed on the server.
+ * Value: true , if the row focusing has been changed on the server; otherwise, false.
+ */
+ isChangedOnServer: boolean;
+}
+/**
+ * A method that will handle the client RowFocusing event.
+ */
+interface ASPxClientGridViewRowFocusingEventHandler {
+ /**
+ * Represents a method that will handle the RowFocusing event.
+ * @param source The event source.
+ * @param e An ASPxClientGridViewRowFocusingEventArgs object which contains event data.
+ */
+ (source: S, e: ASPxClientGridViewRowFocusingEventArgs): void;
+}
+/**
+ * Provides data for the RowFocusing event.
+ */
+interface ASPxClientGridViewRowFocusingEventArgs extends ASPxClientGridViewRowCancelEventArgs {
+ /**
+ * Provides access to the parameters associated with the RowFocusing event.
+ * Value: An object that contains parameters associated with the event.
+ */
+ htmlEvent: Object;
+}
/**
* A method that will handle the RowClick events.
*/
@@ -7829,6 +8173,30 @@ interface ASPxClientGridViewBatchEditApi {
* @param visibleIndex An integer value that identifies the row by its visible index.
*/
IsNewRow(visibleIndex: number): boolean;
+ /**
+ * Adds a new row when ASPxGridView is in Batch Edit mode.
+ */
+ AddNewRow(): void;
+ /**
+ * Deletes the specified row when ASPxGridView is in Batch Edit.
+ * @param visibleIndex An integer value that identifies the row index.
+ */
+ DeleteRow(visibleIndex: number): void;
+ /**
+ * Deletes a row with a specified key value when ASPxGridView is in Batch Edit mode.
+ * @param key An object that uniquely identifies the row.
+ */
+ DeleteRowByKey(key: Object): void;
+ /**
+ * Recovers the specified row when ASPxGridView is in Batch Edit mode.
+ * @param visibleIndex An integer value that identifies the row index.
+ */
+ RecoverRow(visibleIndex: number): void;
+ /**
+ * Recovers a row with a specified key value when ASPxGridView is in Batch Edit mode.
+ * @param key An object that uniquely identifies the row.
+ */
+ RecoverRowByKey(key: Object): void;
/**
* Programmatically moves the focus to the previous cell in the row.
*/
@@ -7906,6 +8274,17 @@ interface ASPxClientGridViewBatchEditApi {
* Ends cell or row editing.
*/
EndEdit(): void;
+ /**
+ * Provides the text displayed within the cell according to the specified display format rule.
+ * @param columnFieldNameOrId A string value representing the column's unique identifier or field name.
+ * @param value An object representing a value.
+ */
+ GetColumnDisplayText(columnFieldNameOrId: string, value: Object): string;
+}
+/**
+ * Lists values that specify the document formats available for export from the grid.
+ */
+interface ASPxClientGridViewExportFormat extends ASPxClientGridExportFormat {
}
/**
* A client-side equivalent of the ASPxVerticalGrid object.
@@ -8207,6 +8586,11 @@ interface ASPxClientVerticalGrid extends ASPxClientGridBase {
* @param visibleIndex An integer value that identifies the record by its visible index.
*/
IsRecordSelectedOnPage(visibleIndex: number): boolean;
+ /**
+ * Exports a grid data to a file in the specified format.
+ * @param format An ASPxClientVerticalGridExportFormat object specifying the export format.
+ */
+ ExportTo(format: ASPxClientVerticalGridExportFormat): void;
/**
* Returns the values of the specified data source fields within the specified record.
* @param visibleIndex An integer value that identifies the record.
@@ -8221,7 +8605,7 @@ interface ASPxClientVerticalGrid extends ASPxClientGridBase {
*/
GetPageRecordValues(fieldNames: string, onCallback: ASPxClientVerticalGridValuesCallback): void;
/**
- * Returns the number of records actually displayed within the active page.
+ * Returns the number of records actually displayed on the active page.
*/
GetVisibleRecordsOnPage(): number;
/**
@@ -8338,6 +8722,11 @@ interface ASPxClientVerticalGrid extends ASPxClientGridBase {
* @param isFilterEnabled true to enable the current filter; otherwise, false.
*/
SetFilterEnabled(isFilterEnabled: boolean): void;
+ /**
+ * Specifies a custom editor for the search panel on the client side.
+ * @param editor An ASPxClientEdit object representing a custom editor.
+ */
+ SetSearchPanelCustomEditor(editor: ASPxClientEdit): void;
/**
* Returns the client row that resides at the specified position within the row collection.
* @param rowIndex A zero-based index that identifies the row within the row collection (the row's Index property value).
@@ -8903,6 +9292,30 @@ interface ASPxClientVerticalGridBatchEditApi {
* @param visibleIndex An integer value that identifies the record by its visible index.
*/
IsNewRecord(visibleIndex: number): boolean;
+ /**
+ * Adds a new record when ASPxVerticalGrid is in Batch Edit mode.
+ */
+ AddNewRecord(): void;
+ /**
+ * Deletes the specified record when ASPxVerticalGrid is in Batch Edit mode.
+ * @param visibleIndex An integer value that identifies the record index.
+ */
+ DeleteRecord(visibleIndex: number): void;
+ /**
+ * Deletes a record with a specified key value when ASPxVerticalGrid is in Batch Edit mode.
+ * @param key An object that uniquely identifies the record.
+ */
+ DeleteRecordByKey(key: Object): void;
+ /**
+ * Recovers the specified record when ASPxVerticalGrid is in Batch Edit mode.
+ * @param visibleIndex An integer value that identifies the record index.
+ */
+ RecoverRecord(visibleIndex: number): void;
+ /**
+ * Recovers a record with a specified key value when ASPxVerticalGrid is in Batch Edit mode.
+ * @param key An object that uniquely identifies the record.
+ */
+ RecoverRecordByKey(key: Object): void;
/**
* Programmatically moves the focus to the previous cell in the record.
*/
@@ -8980,6 +9393,17 @@ interface ASPxClientVerticalGridBatchEditApi {
* Ends the cell(s) editing.
*/
EndEdit(): void;
+ /**
+ * Provides the text displayed within the cell according to the specified display format rule.
+ * @param columnFieldNameOrId A string value representing the row's unique identifier or field name.
+ * @param value An object representing a value.
+ */
+ GetColumnDisplayText(columnFieldNameOrId: string, value: Object): string;
+}
+/**
+ * Lists values that specify the document formats available for export from the grid.
+ */
+interface ASPxClientVerticalGridExportFormat extends ASPxClientGridExportFormat {
}
/**
* Contains style settings related to media elements in ASPxHtmlEditor.
@@ -9886,6 +10310,11 @@ interface ASPxClientHtmlEditor extends ASPxClientControl {
* Performs validation of the editor's content.
*/
Validate(): void;
+ /**
+ * Returns a toolbar specified by its name.
+ * @param name A string value specifying the toolbar name.
+ */
+ GetToolbarByName(name: string): ASPxClientMenu;
/**
* Set an active tab specified by its name.
* @param name A string value that is the name of the tab.
@@ -10730,22 +11159,246 @@ interface ASPxClientRichEditHyperlinkClickEventArgs extends ASPxClientEventArgs
*/
targetUri: string;
}
+/**
+ * A method that will handle the KeyDown event.
+ */
+interface ASPxClientRichEditKeyDownEventHandler {
+ /**
+ * A method that will handle the KeyDown event.
+ * @param source The event source.
+ * @param e An ASPxClientRichEditKeyDownEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditKeyDownEventArgs): void;
+}
+/**
+ * Provides data for the KeyDown event.
+ */
+interface ASPxClientRichEditKeyDownEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets or sets whether the event is handled manually, so no default processing is required.
+ * Value: true if the event is handled and no default processing is required; otherwise false.
+ */
+ handled: boolean;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: An object that maintains DHTML event-specific information.
+ */
+ htmlEvent: Object;
+}
+/**
+ * A method that will handle the KeyUp event.
+ */
+interface ASPxClientRichEditKeyUpEventHandler {
+ /**
+ * A method that will handle the KeyUp event.
+ * @param source The event source.
+ * @param e An ASPxClientRichEditKeyUpEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditKeyUpEventArgs): void;
+}
+/**
+ * Provides data for the KeyUp event.
+ */
+interface ASPxClientRichEditKeyUpEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: An object that maintains DHTML event-specific information.
+ */
+ htmlEvent: Object;
+}
+/**
+ * A method that will handle the PointerDown event.
+ */
+interface ASPxClientRichEditPointerDownEventHandler {
+ /**
+ * A method that will handle the PointerDown event.
+ * @param source The event source.
+ * @param e An ASPxClientRichEditPointerDownEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditPointerDownEventArgs): void;
+}
+/**
+ * Provides data for the PointerDown event.
+ */
+interface ASPxClientRichEditPointerDownEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets or sets whether the event is handled manually, so no default processing is required.
+ * Value: true if the event is handled and no default processing is required; otherwise false.
+ */
+ handled: boolean;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: An object that maintains DHTML event-specific information.
+ */
+ htmlEvent: Object;
+}
+/**
+ * A method that will handle the PointerUp event.
+ */
+interface ASPxClientRichEditPointerUpEventHandler {
+ /**
+ * A method that will handle the PointerUp event.
+ * @param source The event source.
+ * @param e An ASPxClientRichEditPointerUpEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditPointerUpEventArgs): void;
+}
+/**
+ * Provides data for the PointerUp event.
+ */
+interface ASPxClientRichEditPointerUpEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets or sets whether the event is handled manually, so no default processing is required.
+ * Value: true if the event is handled and no default processing is required; otherwise false.
+ */
+ handled: boolean;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: An object that maintains DHTML event-specific information.
+ */
+ htmlEvent: Object;
+}
+/**
+ * A method that will handle the ContentInserted event.
+ */
+interface ASPxClientRichEditContentInsertedEventHandler {
+ /**
+ * A method that will handle the ContentInserted event.
+ * @param source The event source
+ * @param e An ASPxClientRichEditContentInsertedEventArgs that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditContentInsertedEventArgs): void;
+}
+/**
+ * Provides data for the ContentInserted event.
+ */
+interface ASPxClientRichEditContentInsertedEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the active sub-document's identifier.
+ * Value: An integer value specifying the sub-document's identifier.
+ */
+ subDocumentId: number;
+ /**
+ * Gets the text buffer interval related to the inserted content.
+ * Value: An object that stores the inserted content's length and position.
+ */
+ interval: Interval;
+}
+/**
+ * A method that will handle the ContentRemoved event.
+ */
+interface ASPxClientRichEditContentRemovedEventHandler {
+ /**
+ * A method that will handle the ContentRemoved event.
+ * @param source The event source
+ * @param e An ASPxClientRichEditContentRemovedEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditContentRemovedEventArgs): void;
+}
+/**
+ * Provides data for the ContentRemoved event.
+ */
+interface ASPxClientRichEditContentRemovedEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the active sub-document's identifier.
+ * Value: An integer value specifying the sub-document's identifier
+ */
+ subDocumentId: number;
+ /**
+ * Gets the text buffer interval related to the removed content.
+ * Value: An object that stores the removed content's length and position.
+ */
+ interval: Interval;
+}
+/**
+ * A method that will handle the CharacterPropertiesChanged event.
+ */
+interface ASPxClientRichEditCharacterPropertiesChangedEventHandler {
+ /**
+ * A method that will handle the CharacterPropertiesChanged event.
+ * @param source The event source
+ * @param e An ASPxClientRichEditCharacterPropertiesChangedEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditCharacterPropertiesChangedEventArgs): void;
+}
+/**
+ * Provides data for the CharacterPropertiesChanged event.
+ */
+interface ASPxClientRichEditCharacterPropertiesChangedEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the active sub-document's identifier.
+ * Value: An integer value specifying the sub-document's identifier.
+ */
+ subDocumentId: number;
+ /**
+ * Gets the text buffer interval related to the changed characters.
+ * Value: An object that stores the changed character length and position.
+ */
+ interval: Interval;
+}
+/**
+ * A method that will handle the ParagraphPropertiesChanged event.
+ */
+interface ASPxClientRichEditParagraphPropertiesChangedEventHandler {
+ /**
+ * A method that will handle the ParagraphPropertiesChanged event.
+ * @param source The event source.
+ * @param e An ASPxClientRichEditParagraphPropertiesChangedEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditParagraphPropertiesChangedEventArgs): void;
+}
+/**
+ * Provides data for the ParagraphPropertiesChanged event.
+ */
+interface ASPxClientRichEditParagraphPropertiesChangedEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the active sub-document's identifier.
+ * Value: An integer value specifying the sub-document's identifier
+ */
+ subDocumentId: number;
+ /**
+ * Gets the changed paragraph's index.
+ * Value: An integer value specifying the changed paragraph's identifier.
+ */
+ paragraphIndex: number;
+}
+/**
+ * A method that will handle the PopupMenuShowing event.
+ */
+interface ASPxClientRichEditPopupMenuShowingEventHandler {
+ /**
+ * A method that will handle the PopupMenuShowing event.
+ * @param source The event source.
+ * @param e An ASPxClientRichEditPopupMenuShowingEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientRichEditPopupMenuShowingEventArgs): void;
+}
+/**
+ * Provides data for the PopupMenuShowing event.
+ */
+interface ASPxClientRichEditPopupMenuShowingEventArgs extends ASPxClientCancelEventArgs {
+ /**
+ * Provides access to a collection of menu items in the context menu being invoked.
+ * Value: A object representing the context menu's item collection.
+ */
+ menuItems: ASPxClientRichEditPopupMenuItemCollection;
+}
/**
* A client-side equivalent of the ASPxRichEdit object.
*/
interface ASPxClientRichEdit extends ASPxClientControl {
/**
* Provides access to document structural elements.
- * Value: A object that lists RichEdit's document structural elements.
+ * Value: A object that lists a RichEdit document's structural elements.
*/
document: RichEditDocument;
/**
- * Provides access to RichEdit's client-side commands.
- * Value: A object that lists RichEdit's client-side commands.
+ * Provides access to the RichEdit's client-side commands.
+ * Value: A object that lists the RichEdit's client-side commands.
*/
commands: RichEditCommands;
/**
- * Provides access to the client methods that changes the selection.
+ * Provides access to the client methods that change the selection.
* Value: A object that lists methods to work with the selection.
*/
selection: RichEditSelection;
@@ -10778,18 +11431,70 @@ interface ASPxClientRichEdit extends ASPxClientControl {
* Fires on the client if any server error occurs during server-side processing of a callback sent by the RichEdit.
*/
CallbackError: ASPxClientEvent>;
+ /**
+ * Occurs on the client side when a document model is loaded into the control.
+ */
+ DocumentLoaded: ASPxClientEvent>;
/**
* Fires if any change is made to the RichEdit's document on the client.
*/
DocumentChanged: ASPxClientEvent>;
/**
- * Occurs when a hyperlink is clicked within the document.
+ * Occurs when the active sub-document is substituted with another sub-document.
+ */
+ ActiveSubDocumentChanged: ASPxClientEvent>;
+ /**
+ * Occurs when the control receives focus.
+ */
+ GotFocus: ASPxClientEvent>;
+ /**
+ * Occurs when the control loses focus.
+ */
+ LostFocus: ASPxClientEvent>;
+ /**
+ * Occurs when the mouse pointer is over the RichEdit's document and a mouse button is pressed.
+ */
+ PointerDown: ASPxClientEvent>;
+ /**
+ * Occurs when the mouse button is released if it was pressed within the RichEdit's document.
+ */
+ PointerUp: ASPxClientEvent>;
+ /**
+ * Occurs when a key is pressed while the ASPxRichEdit's document has focus.
+ */
+ KeyDown: ASPxClientEvent>;
+ /**
+ * Occurs when a key is released while the ASPxRichEdit's document has focus.
+ */
+ KeyUp: ASPxClientEvent>;
+ /**
+ * Occurs when a pop-up menu is about to be shown.
+ */
+ PopupMenuShowing: ASPxClientEvent>;
+ /**
+ * Occurs when a hyperlink is activated within the document.
*/
HyperlinkClick: ASPxClientEvent>;
/**
* Occurs when the selection is changed within the document.
*/
SelectionChanged: ASPxClientEvent>;
+ /**
+ * Occurs when content is inserted into the document.
+ */
+ ContentInserted: ASPxClientEvent>;
+ /**
+ * Occurs when content is removed from the document
+ */
+ ContentRemoved: ASPxClientEvent>;
+ /**
+ * Occurs when the characters' formatting is changed.
+ */
+ CharacterPropertiesChanged: ASPxClientEvent>;
+ /**
+ * Occurs when a paragraph's formatting is changed.
+ */
+ ParagraphPropertiesChanged: ASPxClientEvent>;
/**
* Enables you to switch the full-screen mode of the Rich Text Editor.
* @param fullscreen true to activate full-screen mode; false to deactivate full-screen mode.
@@ -10823,6 +11528,123 @@ interface ASPxClientRichEdit extends ASPxClientControl {
*/
ReconnectToExternalRibbon(): void;
}
+/**
+ * Represents an individual item of the Rich Edit's context menu.
+ */
+interface ASPxClientRichEditPopupMenuItem {
+ /**
+ * Gets the immediate parent menu item to which the current menu item belongs.
+ * Value: A ASPxClientRichEditPopupMenuItem object representing the menu item's immediate parent.
+ */
+ parent: ASPxClientRichEditPopupMenuItem;
+ /**
+ * Gets or sets the unique identifier name for the current menu item.
+ * Value: A string value that specifies the item's unique identifier name.
+ */
+ name: string;
+ /**
+ * Gets or sets the text content of the current menu item.
+ * Value: A string value that specifies the text content of the menu item.
+ */
+ text: string;
+ /**
+ * Gets or sets a value that indicates whether the menu item is enabled, allowing the item to respond to end-user interactions.
+ * Value: true if the item is enabled; otherwise, false.
+ */
+ enabled: boolean;
+ /**
+ * Gets or sets the CSS class name defining the menu item's image.
+ * Value: A string value specifying the class name.
+ */
+ imageClassName: string;
+ /**
+ * Gets or sets a URL which defines the navigation location.
+ * Value: A string value which represents a URL where the client web browser will navigate.
+ */
+ navigateUrl: string;
+ /**
+ * Gets or sets the URL of the menu item's image.
+ * Value: A string value that specifies the location of an image.
+ */
+ imageUrl: string;
+ /**
+ * Gets or sets a value that specifies whether the current menu item starts a group.
+ * Value: true if the current menu item starts a group; otherwise, false.
+ */
+ beginGroup: boolean;
+ /**
+ * Gets or sets the current menu item's tooltip text.
+ * Value: A string which specifies the text content of the current menu item's tooltip.
+ */
+ tooltip: string;
+ /**
+ * Gets or sets the window or frame at which to target the contents of the URL associated with the current menu item.
+ * Value: A string which identifies the window or frame at which to target the URL content.
+ */
+ target: string;
+ /**
+ * Gets a collection that contains the submenu items of the current menu item.
+ */
+ GetSubItems(): ASPxClientRichEditPopupMenuItemCollection;
+ /**
+ * Returns the menu item's sub-item with the specified index.
+ * @param index An integer value specifying the index of the sub-item within a collection of the current menu item's submenu items.
+ */
+ GetItem(index: number): ASPxClientRichEditPopupMenuItem;
+ /**
+ * Returns the menu item's sub-item with the specified name property value.
+ * @param name A string value specifying the name property value of the sub-item to find.
+ */
+ GetItemByName(name: string): ASPxClientRichEditPopupMenuItem;
+ /**
+ * Returns the total number of the menu item's child items (submenu items).
+ */
+ GetItemCount(): number;
+}
+/**
+ * Represents a collection of items in the Rich Edit's context menu.
+ */
+interface ASPxClientRichEditPopupMenuItemCollection {
+ /**
+ * Adds the specified menu item to the end of the collection.
+ * @param item An ASPxClientRichEditPopupMenuItem object specifying the item to be added to the collection.
+ */
+ Add(item: ASPxClientRichEditPopupMenuItem): void;
+ /**
+ * Removes a menu item specified by its index within the collection.
+ * @param index An integer value specifying the index of the menu item to remove.
+ */
+ Remove(index: number): void;
+ /**
+ * Removes a menu item specified by its name.
+ * @param name A string value specifying the name property value of a menu item to remove from the collection.
+ */
+ RemoveByName(name: string): void;
+ /**
+ * Adds the specified item to the specified position within the collection.
+ * @param index An integer value that specifies the zero-based index at which the specified item should be inserted.
+ * @param item An ASPxClientRichEditPopupMenuItem object to insert.
+ */
+ Insert(index: number, item: ASPxClientRichEditPopupMenuItem): void;
+ /**
+ * Returns the total number of menu items in the collection.
+ */
+ GetCount(): number;
+ /**
+ * Returns an item object with the specified name property value.
+ * @param name A string value representing the name property value of the required item.
+ */
+ GetByName(name: string): ASPxClientRichEditPopupMenuItem;
+ /**
+ * Returns a menu item specified by its index in the collection.
+ * @param index An integer value that is the zero-based index of the to retrieve from the ASPxClientRichEditPopupMenuItemCollection.
+ */
+ Get(index: number): ASPxClientRichEditPopupMenuItem;
+ /**
+ * Removes all menu items from the collection.
+ */
+ Clear(): void;
+}
/**
* Contains a set of the available client commands.
*/
@@ -10833,7 +11655,7 @@ interface RichEditCommands {
*/
fileNew: FileNewCommand;
/**
- * Gets a command to open the file, specifying its path.
+ * Gets a command to open a document stored in the specified file.
* Value: A object that provides methods for executing the command and checking its state.
*/
fileOpen: FileOpenCommand;
@@ -10843,22 +11665,22 @@ interface RichEditCommands {
*/
fileOpenDialog: FileOpenDialogCommand;
/**
- * Gets a command to save the document to a file.
+ * Gets a command to save the document at its original location on the server.
* Value: A object that provides methods for executing the command and checking its state.
*/
fileSave: FileSaveCommand;
/**
- * Gets a command to download the document file, specifying its extension.
+ * Gets a command to download the document specifying the file's extension.
* Value: A object that provides methods for executing the command and checking its state.
*/
fileDownload: FileDownloadCommand;
/**
- * Gets a command to invoke the Save As dialog that prompts for a file name and saves the current document in a file with the specified path.
+ * Gets a command to save a document in a file with the specified path.
* Value: A object that provides methods for executing the command and checking its state.
*/
fileSaveAs: FileSaveAsCommand;
/**
- * Gets a command to open the file's Save As dialog.
+ * Gets a command to invoke the Save As dialog that prompts for a file name and saves the current document in a file with the specified path.
* Value: A object that provides methods for executing the command and checking its state.
*/
fileSaveAsDialog: FileSaveAsDialogCommand;
@@ -10898,17 +11720,17 @@ interface RichEditCommands {
*/
changeFontName: ChangeFontNameCommand;
/**
- * Gets a command to change the font size of characters in a selected range.
+ * Gets a command to change the font size (in points) of characters in a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeFontSize: ChangeFontSizeCommand;
/**
- * Gets a command to increase the font size of characters in a selected range to the closest larger predefined value.
+ * Gets a command to increase the font size of characters in a selected range to the closest larger predefined value (in points).
* Value: A object that provides methods for executing the command and checking its state.
*/
increaseFontSize: IncreaseFontSizeCommand;
/**
- * Gets a command to decrease the selected range's font size to the closest smaller predefined value.
+ * Gets a command to decrease the selected range's font size to the closest smaller predefined value (in points).
* Value: A object that provides methods for executing the command and checking its state.
*/
decreaseFontSize: DecreaseFontSizeCommand;
@@ -10958,7 +11780,7 @@ interface RichEditCommands {
*/
changeFontSuperscript: ChangeFontSuperscriptCommand;
/**
- * Gets a command to change the subscript formatting of characters in the selected range.
+ * Gets a command to change the subscript formatting of characters in a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeFontSubscript: ChangeFontSubscriptCommand;
@@ -10973,12 +11795,12 @@ interface RichEditCommands {
*/
changeFontBackColor: ChangeFontBackColorCommand;
/**
- * Gets a command to reset text and paragraph formatting in the selected range to default.
+ * Gets a command to reset textual and paragraph formatting in the selected range to default values.
* Value: A object that provides methods for executing the command and checking its state.
*/
clearFormatting: ClearFormattingCommand;
/**
- * Gets a command to change the selected range's style.
+ * Gets a command to apply a character or paragraph style settings to text in a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeStyle: ChangeStyleCommand;
@@ -11088,7 +11910,7 @@ interface RichEditCommands {
*/
openParagraphFormattingDialog: OpenParagraphFormattingDialogCommand;
/**
- * Gets a command to change the formatting of paragraphs in a selected range.
+ * Gets a command to apply formatting settings to paragraphs within a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeParagraphFormatting: ChangeParagraphFormattingCommand;
@@ -11103,7 +11925,7 @@ interface RichEditCommands {
*/
openInsertTableDialog: OpenInsertTableDialogCommand;
/**
- * Gets a command to insert a rectangle table of a specified size.
+ * Gets a command to insert a rectangular table of the specified size.
* Value: A object that provides methods for executing the command and checking its state.
*/
insertTable: InsertTableCommand;
@@ -11113,7 +11935,7 @@ interface RichEditCommands {
*/
openInsertPictureDialog: OpenInsertPictureDialogCommand;
/**
- * Gets a command to insert an inline picture stored by specifed web address.
+ * Gets a command to insert an inline picture stored by the specified web address.
* Value: A object that provides methods for executing the command and checking its state.
*/
insertPicture: InsertPictureCommand;
@@ -11143,7 +11965,7 @@ interface RichEditCommands {
*/
openInsertHyperlinkDialog: OpenInsertHyperlinkDialogCommand;
/**
- * Gets a command to insert a hyperlink at the current position in the document.
+ * Gets a command to insert and update a hyperlink field in place of a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
insertHyperlink: InsertHyperlinkCommand;
@@ -11158,7 +11980,7 @@ interface RichEditCommands {
*/
deleteHyperlinks: DeleteHyperlinksCommand;
/**
- * Gets a command to navigate to the document bookmark or URI (uniform resource identifier) specified for the hyperlink.
+ * Gets a command to go to a bookmark or URI contained within the selected hyperlink.
* Value: A object that provides methods for executing the command and checking its state.
*/
openHyperlink: OpenHyperlinkCommand;
@@ -11168,12 +11990,12 @@ interface RichEditCommands {
*/
openInsertSymbolDialog: OpenInsertSymbolDialogCommand;
/**
- * Gets a command to insert a character into a document.
+ * Gets a command to insert characters into a document instead of a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
insertSymbol: InsertSymbolCommand;
/**
- * Gets a command to change page margin settings.
+ * Gets a command to apply page margins settings to sections located within a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
changePageMargins: ChangePageMarginsCommand;
@@ -11183,12 +12005,12 @@ interface RichEditCommands {
*/
openPageMarginsDialog: OpenPageMarginsDialogCommand;
/**
- * Gets a command to change the page orientation.
+ * Gets a command to apply page orientation settings to sections located within a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
changePageOrientation: ChangePageOrientationCommand;
/**
- * Gets a command to define the page size dialog's settings.
+ * Gets a command to invoke the Page Setup dialog.
* Value: A object that provides methods for executing the command and checking its state.
*/
setPageSizeDialog: SetPageSizeDialogCommand;
@@ -11198,12 +12020,12 @@ interface RichEditCommands {
*/
openPagePaperSizeDialog: OpenPagePaperSizeDialogCommand;
/**
- * Gets a command to change the page size.
+ * Gets a command to apply page size settings to sections located within a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
changePageSize: ChangePageSizeCommand;
/**
- * Gets a command to change the number of section columns having the same width.
+ * Gets a command to change the number of columns having the same width in a section.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeSectionEqualColumnCount: ChangeSectionEqualColumnCountCommand;
@@ -11213,7 +12035,7 @@ interface RichEditCommands {
*/
openSectionColumnsDialog: OpenSectionColumnsDialogCommand;
/**
- * Gets a command to change the settings of individual section columns.
+ * Gets a command to apply column layout settings to a section.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeSectionColumns: ChangeSectionColumnsCommand;
@@ -11238,7 +12060,7 @@ interface RichEditCommands {
*/
insertSectionBreakOddPage: InsertSectionBreakOddPageCommand;
/**
- * Gets a command to set the background color of the page.
+ * Gets a command to set the background color of all pages contained in the document.
* Value: A object that provides methods for executing the command and checking its state.
*/
changePageColor: ChangePageColorCommand;
@@ -11263,12 +12085,12 @@ interface RichEditCommands {
*/
insertParagraph: InsertParagraphCommand;
/**
- * Gets a command to insert text at the current position in a document.
+ * Gets a command to insert text in place of a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
insertText: InsertTextCommand;
/**
- * Gets a command to delete the text in a selected range.
+ * Gets a command to delete text and in-line objects in a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
delete: DeleteCommand;
@@ -11283,7 +12105,7 @@ interface RichEditCommands {
*/
removeNextWord: RemoveNextWordCommand;
/**
- * Gets a command to move the cursor backwards and erase the character in that space.
+ * Gets a command to move the cursor backwards and erase characters in a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
backspace: BackspaceCommand;
@@ -11293,12 +12115,12 @@ interface RichEditCommands {
*/
insertLineBreak: InsertLineBreakCommand;
/**
- * Gets a command to scale pictures in a selected range.
+ * Gets a command to scale a selected in-line picture.
* Value: A object that provides methods for executing the command and checking its state.
*/
changePictureScale: ChangePictureScaleCommand;
/**
- * Gets a command to increment the left indentation of paragraphs in a selected range.
+ * Gets a command to increment the left indent of paragraphs in a selected range.
* Value: A object that provides methods for executing the command and checking its state.
*/
incrementParagraphLeftIndent: IncrementParagraphLeftIndentCommand;
@@ -11322,13 +12144,18 @@ interface RichEditCommands {
* Value: A object that provides methods for executing the command and checking its state.
*/
insertTab: InsertTabCommand;
+ /**
+ * Gets a command to add a non-breaking space in place of a selected range
+ * Value: A object that provides methods for executing the command and checking its state.
+ */
+ insertNonBreakingSpace: InsertNonBreakingSpaceCommand;
/**
* Gets a command to invoke the Tabs dialog window.
* Value: A object that provides methods for executing the command and checking its state.
*/
openTabsDialog: OpenTabsDialogCommand;
/**
- * Gets a command to change the tab stop value of a document or selected paragraphs
+ * Gets a command to change the default tab stop value of a document and apply custom tab settings to the selected paragraphs.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeTabs: ChangeTabsCommand;
@@ -11358,12 +12185,12 @@ interface RichEditCommands {
*/
decrementNumberingIndent: DecrementNumberingIndentCommand;
/**
- * Gets a command to create a field with an empty code and populate it with the selection (if it is not collapsed).
+ * Gets a command to create a field with an empty code and populate it with the characters in the selected range (if it is not collapsed).
* Value: A object that provides methods for executing the command and checking its state.
*/
createField: CreateFieldCommand;
/**
- * Gets a command to update the field's result.
+ * Gets a command to update each field's result in the selection.
* Value: A object that provides methods for executing the command and checking its state.
*/
updateField: UpdateFieldCommand;
@@ -11388,12 +12215,12 @@ interface RichEditCommands {
*/
insertNumeration: InsertNumerationCommand;
/**
- * Gets a command to remove the selected numeration.
+ * Gets a command to exclude the selected paragraphs from the numbered list.
* Value: A object that provides methods for executing the command and checking its state.
*/
removeNumeration: RemoveNumerationCommand;
/**
- * Gets a command to update all fields in the selected range.
+ * Gets a command to update all fields in the document.
* Value: A object that provides methods for executing the command and checking its state.
*/
updateAllFields: UpdateAllFieldsCommand;
@@ -11413,12 +12240,12 @@ interface RichEditCommands {
*/
createPageField: CreatePageFieldCommand;
/**
- * Gets a command to convert the text of all selected sentences to sentence case.
+ * Gets a command changing all selected text to the sentence case capitalization.
* Value: A object that provides methods for executing the command and checking its state.
*/
makeTextSentenceCase: MakeTextSentenceCaseCommand;
/**
- * Gets a command to switch the text case at the current position in the document.
+ * Gets a command to switch the text capitalization in the selection.
* Value: A object that provides methods for executing the command and checking its state.
*/
switchTextCase: SwitchTextCaseCommand;
@@ -11438,7 +12265,7 @@ interface RichEditCommands {
*/
goToNextDataRecord: GoToNextDataRecordCommand;
/**
- * Gets a command to navigate to the next data record.
+ * Gets a command to open the specified data record.
* Value: A object that provides methods for executing the command and checking its state.
*/
goToDataRecord: GoToDataRecordCommand;
@@ -11478,12 +12305,12 @@ interface RichEditCommands {
*/
mailMergeAndSaveAs: MailMergeAndSaveAsCommand;
/**
- * Gets a command to activate the page header and begin editing.
+ * Gets a command to create a header sub-document (if it is not yet created) and set it as an active sub-document instead of the main sub-document.
* Value: A object that provides methods for executing the command and checking its state.
*/
insertHeader: InsertHeaderCommand;
/**
- * Gets a command to activate the page footer and begin editing.
+ * Gets a command to create a footer sub-document (if it is not yet created) and set it as an active sub-document instead of the main sub-document.
* Value: A object that provides methods for executing the command and checking its state.
*/
insertFooter: InsertFooterCommand;
@@ -11493,37 +12320,37 @@ interface RichEditCommands {
*/
linkHeaderFooterToPrevious: LinkHeaderFooterToPreviousCommand;
/**
- * Gets a command to navigate to the page footer from the page header in the header/footer editing mode.
+ * Gets a command to substitute a header sub-document with a footer sub-document of the same page as an active sub-document.
* Value: A object that provides methods for executing the command and checking its state.
*/
goToFooter: GoToFooterCommand;
/**
- * Gets a command to navigate to the page header from the page footer in the header/footer editing mode.
+ * Gets a command to substitute a footer sub-document with a header sub-document of the same page as an active sub-document.
* Value: A object that provides methods for executing the command and checking its state.
*/
goToHeader: GoToHeaderCommand;
/**
- * Gets a command to navigate to the next page header or footer in the header/footer editing mode.
+ * Gets a command to substitute a current header/footer with a header/footer of the next section as an active sub-document.
* Value: A object that provides methods for executing the command and checking its state.
*/
goToNextHeaderFooter: GoToNextHeaderFooterCommand;
/**
- * Gets a command to navigate to the previous page header or footer in the header/footer editing mode.
+ * Gets a command to substitute a current header/footer with a header/footer of the previous section as an active sub-document.
* Value: A object that provides methods for executing the command and checking its state.
*/
goToPreviousHeaderFooter: GoToPreviousHeaderFooterCommand;
/**
- * Gets a command to change the header/footer edit mode, so it allows creation of a different header or footer for the first page of a document or section.
+ * Gets a command to enable (or disable if it is enabled) a different page header and footer for the first page of the current section.
* Value: A object that provides methods for executing the command and checking its state.
*/
setDifferentFirstPageHeaderFooter: SetDifferentFirstPageHeaderFooterCommand;
/**
- * Gets a command to change the header/footer edit mode so it allows creation of a different header or footer for odd and even pages of a document or section.
+ * Gets a command to enable (or disable if it is enabled) a different page header and footer for odd and even pages of the current section.
* Value: A object that provides methods for executing the command and checking its state.
*/
setDifferentOddAndEvenPagesHeaderFooter: SetDifferentOddAndEvenPagesHeaderFooterCommand;
/**
- * Gets a command to finish header/footer editing.
+ * Gets a command to substitute a header/footer sub-document with the main sub-document as an active sub-document.
* Value: A object that provides methods for executing the command and checking its state.
*/
closeHeaderFooter: CloseHeaderFooterCommand;
@@ -11553,7 +12380,7 @@ interface RichEditCommands {
*/
changeTableCellPreferredWidth: ChangeTableCellPreferredWidthCommand;
/**
- * Gets a command to toggle inside borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the inside borders for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellInsideBorders: ToggleTableCellInsideBordersCommand;
@@ -11708,22 +12535,22 @@ interface RichEditCommands {
*/
changeTableStyle: ChangeTableStyleCommand;
/**
- * Gets a command to toggle top borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the top border for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellTopBorder: ToggleTableCellTopBorderCommand;
/**
- * Gets a command to toggle right borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the right border for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellRightBorder: ToggleTableCellRightBorderCommand;
/**
- * Gets a command to toggle bottom borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the bottom border for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellBottomBorder: ToggleTableCellBottomBorderCommand;
/**
- * Gets a command to toggle left borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the left border for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellLeftBorder: ToggleTableCellLeftBorderCommand;
@@ -11733,22 +12560,22 @@ interface RichEditCommands {
*/
removeTableCellBorders: RemoveTableCellBordersCommand;
/**
- * Gets a command to toggle all borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings to all borders of the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellAllBorders: ToggleTableCellAllBordersCommand;
/**
- * Gets a command to toggle inner horizontal borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the inside horizontal borders for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellInsideHorizontalBorders: ToggleTableCellInsideHorizontalBordersCommand;
/**
- * Gets a command to toggle inner vertical borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the inside vertical borders for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellInsideVerticalBorders: ToggleTableCellInsideVerticalBordersCommand;
/**
- * Gets a command to toggle outer borders for selected cells on/off.
+ * Gets a command to apply (or cancel) border settings of the outside borders for the selected cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
toggleTableCellOutsideBorders: ToggleTableCellOutsideBordersCommand;
@@ -11758,12 +12585,12 @@ interface RichEditCommands {
*/
changeTableLook: ChangeTableLookCommand;
/**
- * Gets a command to change the repository item's table border style.
+ * Gets a command to apply borders' drawing settings.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeTableBorderRepositoryItem: ChangeTableBorderRepositoryItemCommand;
/**
- * Gets a command to change cell shading in the selected table elements.
+ * Gets a command to change cell shading in selected table cells.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeTableCellShading: ChangeTableCellShadingCommand;
@@ -11788,17 +12615,17 @@ interface RichEditCommands {
*/
findAll: FindAllCommand;
/**
- * Gets a command to hide the results of the search.
+ * Gets a command to hide the search results.
* Value: A object that provides methods for executing the command and checking its state.
*/
hideFindResults: HideFindResultsCommand;
/**
- * Gets a command to search for a specific text and replace all matches in the document with the specified string.
+ * Gets a command to replace all matches of the specified text with new characters.
* Value: A object that provides methods for executing the command and checking its state.
*/
replaceAll: ReplaceAllCommand;
/**
- * Gets a command to search for a specific text and replace the next match in the document with the specified string.
+ * Gets a command to find and replace a next match of the specified text after the cursor position with new characters.
* Value: A object that provides methods for executing the command and checking its state.
*/
replaceNext: ReplaceNextCommand;
@@ -11853,7 +12680,7 @@ interface RichEditCommands {
*/
changeFloatingObjectAbsoluteSize: ChangeFloatingObjectAbsoluteSizeCommand;
/**
- * Gets a command to modify a text box' relative size settings.
+ * Gets a command to modify a text box's relative size settings.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeTextBoxRelativeSize: ChangeTextBoxRelativeSizeCommand;
@@ -11883,11 +12710,20 @@ interface RichEditCommands {
*/
changeFloatingObjectOutlineWidth: ChangeFloatingObjectOutlineWidthCommand;
/**
- * Gets a command to modify a text box' content margins.
+ * Gets a command to modify a text box's content margins.
* Value: A object that provides methods for executing the command and checking its state.
*/
changeTextBoxContentMargins: ChangeTextBoxContentMarginsCommand;
+ /**
+ * Gets a command to resize the shape to fit the text in the text box.
+ * Value: A object that provides methods for executing the command and checking its state.
+ */
changeTextBoxResizeShapeToFitText: ChangeTextBoxResizeShapeToFitTextCommand;
+ /**
+ * Gets a command to add an HTML formatted content in place of a selected range.
+ * Value: A object that provides methods for executing the command and checking its state.
+ */
+ insertHtml: InsertHtmlCommand;
}
/**
* Serves as a base for objects that implement different client command functionalities.
@@ -11981,6 +12817,10 @@ interface RichEditDocument {
* An abstract numbering list definition that defines the appearance and behavior of numbered paragraphs in a document.
*/
interface AbstractNumberingList {
+ /**
+ * Gets or sets a value indicating whether an abstract numbering list is deleted.
+ * Value: true, if the abstract numbering list is deleted; otherwise, false.
+ */
deleted: boolean;
}
/**
@@ -12067,6 +12907,11 @@ interface Field {
* Value: true, if the field code is displayed; false, if the field result is displayed.
*/
showCode: boolean;
+ /**
+ * Gets the index of the field
+ * Value: An integer value specifying the field's index
+ */
+ index: number;
}
/**
* Defines a bookmark in the document.
@@ -12468,7 +13313,7 @@ interface SpellingInfo {
spellCheckerState: any;
/**
* Provides access to an array containing misspelled intervals.
- * Value: An array of objects.
+ * Value: An array of MisspelledInterval objects.
*/
misspelledIntervals: MisspelledInterval[];
}
@@ -12635,6 +13480,26 @@ interface SubDocument {
* Value: An integer that is the number of character positions in the document.
*/
length: number;
+ /**
+ * Returns a field if its interval includes the specified position.
+ * @param position An integer value specifying the target field's position.
+ */
+ findFields(position: number): Field[];
+ /**
+ * Returns all fields contained in the specified interval.
+ * @param interval A text buffer interval that contains the target fields.
+ */
+ findFields(interval: Interval): Field[];
+ /**
+ * Returns a table if its interval includes the specified position.
+ * @param position An integer value specifying the target table's position.
+ */
+ findTables(position: number): Field[];
+ /**
+ * Returns all tables contained in the specified interval.
+ * @param interval A text buffer interval that contains the target tables.
+ */
+ findTables(interval: Interval): Field[];
}
declare enum SubDocumentType {
Main=0,
@@ -12656,6 +13521,11 @@ interface Table {
* Value: A integer value specifying the character length of the table.
*/
length: number;
+ /**
+ * Gets an index of the table.
+ * Value: An integer value specifying the table's index.
+ */
+ index: number;
/**
* Gets the text buffer interval occupied by the current table element.
* Value: An object specifying the interval settings.
@@ -12809,7 +13679,7 @@ interface DeleteBookmarkCommand extends CommandWithSimpleStateBase {
interface GoToBookmarkCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToBookmarkCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param name
+ * @param name A string value specifying the bookmark's name
*/
execute(name: string): boolean;
}
@@ -12857,6 +13727,11 @@ interface UpdateFieldCommand extends CommandWithSimpleStateBase {
* Executes the UpdateFieldCommand command by imitating the corresponding end-user action made in the RichEdit's UI. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
*/
execute(): boolean;
+ /**
+ * Executes the UpdateFieldCommand command by imitating the corresponding end-user action made in the RichEdit's UI. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
+ * @param callback A callback function that is performed when updating of all fields in the selection is completed.
+ */
+ execute(callback: Function): boolean;
}
/**
* A command to display the selected field's field codes.
@@ -12894,6 +13769,11 @@ interface UpdateAllFieldsCommand extends CommandWithSimpleStateBase {
* Executes the UpdateAllFieldsCommand command by imitating the corresponding end-user action made in the RichEdit's UI. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
*/
execute(): boolean;
+ /**
+ * Executes the UpdateAllFieldsCommand command by imitating the corresponding end-user action made in the RichEdit's UI. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
+ * @param callback A callback function that is performed when updating of all fields in the document is completed.
+ */
+ execute(callback: Function): boolean;
}
/**
* A command to insert a DATE field displaying the current date.
@@ -12945,6 +13825,10 @@ interface DataRecordOptions {
* Value: An integer value specifying the data record index.
*/
activeRecordIndex: number;
+ /**
+ * Gets or sets the count of data source records.
+ * Value: An integer value specifying the count of data source records.
+ */
recordCount: number;
}
/**
@@ -13163,7 +14047,7 @@ interface FileSaveCommand extends CommandWithSimpleStateBase {
interface FileSaveAsCommand extends CommandWithSimpleStateBase {
/**
* Executes the FileSaveAsCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param path A string value specifying path to the saving file.
+ * @param path A string value specifying path to the saving file. Note that the path should be relative to the work directory.
*/
execute(path: string): boolean;
/**
@@ -13231,15 +14115,15 @@ interface FindAllCommand extends CommandWithSimpleStateBase {
* Executes the FindAllCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
* @param text A string value specifying finding text.
* @param matchCase true, to perform a case-sensitive search; otherwise, false.
- * @param highlightResults true, to highlight result of search; otherwise, false.
+ * @param highlightResults true, to highlight the search results; otherwise, false.
*/
execute(text: string, matchCase: boolean, highlightResults: boolean): boolean;
/**
* Executes the FindAllCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
* @param text A string value specifying text to find.
* @param matchCase true, to perform a case-sensitive search; otherwise, false.
- * @param highlightResults true, to highlight result of search; otherwise, false.
- * @param results An array of Interval objects containing the results of search.
+ * @param highlightResults true, to highlight the search results; otherwise, false.
+ * @param results An array of Interval objects containing the search results.
*/
execute(text: string, matchCase: boolean, highlightResults: boolean, results: Interval[]): boolean;
}
@@ -13259,7 +14143,7 @@ interface ReplaceAllCommand extends CommandWithSimpleStateBase {
/**
* Executes the ReplaceAllCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
* @param text A string value specifying a text to replace.
- * @param replaceText A string value specifying the replacing text.
+ * @param replaceText A string value specifying the inserted text.
* @param matchCase true, to perform a case-sensitive search; otherwise, false.
*/
execute(text: string, replaceText: string, matchCase: boolean): boolean;
@@ -13270,8 +14154,8 @@ interface ReplaceAllCommand extends CommandWithSimpleStateBase {
interface ReplaceNextCommand extends CommandWithSimpleStateBase {
/**
* Executes the ReplaceNextCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param text A string value specifying text to replace.
- * @param replaceText A string value specifying replacing text.
+ * @param text A string value specifying a text to replace.
+ * @param replaceText A string value specifying the inserted text.
* @param matchCase true, to perform a case-sensitive search; otherwise, false.
*/
execute(text: string, replaceText: string, matchCase: boolean): boolean;
@@ -13325,7 +14209,7 @@ interface ChangeFloatingObjectAlignmentPositionCommand extends CommandBase {
interface ChangeFloatingObjectAbsolutePositionCommand extends CommandBase {
/**
* Executes the ChangeFloatingObjectAbsolutePositionCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param settings A FloatingObjectAbsolutePositionSettings object specifying page margin settings.
+ * @param settings A FloatingObjectAbsolutePositionSettings object specifying object position settings.
*/
execute(settings: FloatingObjectAbsolutePositionSettings): boolean;
/**
@@ -13473,8 +14357,18 @@ interface ChangeTextBoxContentMarginsCommand extends CommandBase {
*/
getState(): any;
}
+/**
+ * A command to resize the shape to fit the text in the text box.
+ */
interface ChangeTextBoxResizeShapeToFitTextCommand extends CommandBase {
+ /**
+ * Executes the ChangeTextBoxResizeShapeToFitTextCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
+ * @param resizeShapeToFitText true, to resize the shape to fit the text; otherwise, false.
+ */
execute(resizeShapeToFitText: boolean): boolean;
+ /**
+ * Gets information about the command state.
+ */
getState(): any;
}
/**
@@ -13508,7 +14402,7 @@ interface FloatingObjectAlignmentPositionSettings {
interface FloatingObjectAbsolutePositionSettings {
/**
* Gets or sets a floating object's horizontal position relative to an element specified by the horizontalPositionType property.
- * Value: An integer value specifying the position.
+ * Value: An integer value specifying the position in twips.
*/
horizontalAbsolutePosition: number;
/**
@@ -13518,7 +14412,7 @@ interface FloatingObjectAbsolutePositionSettings {
horizontalPositionType: any;
/**
* Gets or sets a floating object's vertical position relative to an element specified by the verticalPositionType property.
- * Value: An integer value specifying the position.
+ * Value: An integer value specifying the position in twips.
*/
verticalAbsolutePosition: number;
/**
@@ -13533,7 +14427,7 @@ interface FloatingObjectAbsolutePositionSettings {
interface FloatingObjectRelativePositionSettings {
/**
* Gets or sets the horizontal distance between the edge of a floating object and the element specified by the horizontalRelativePosition property
- * Value: An integer value specifying the horizontal position.
+ * Value: An integer value specifying the horizontal position in twips.
*/
horizontalRelativePosition: number;
/**
@@ -13543,7 +14437,7 @@ interface FloatingObjectRelativePositionSettings {
horizontalPositionType: any;
/**
* Gets or sets the horizontal distance between the edge of a floating object and the element specified by the verticalRelativePosition property
- * Value: An integer value specifying the vertical position.
+ * Value: An integer value specifying the vertical position in twips.
*/
verticalRelativePosition: number;
/**
@@ -13568,22 +14462,22 @@ interface FloatingObjectTextWrappingSettings {
floatingObjectTextWrapSide: any;
/**
* Gets or sets the left offset of text wrapping.
- * Value: An integer value specifying the left offset.
+ * Value: An integer value specifying the left offset in twips.
*/
leftDistance: number;
/**
* Gets or sets the right offset of text wrapping.
- * Value: An integer value specifying the right offset.
+ * Value: An integer value specifying the right offset in twips.
*/
rightDistance: number;
/**
* Gets or sets the top offset of text wrapping.
- * Value: An integer value specifying the top offset.
+ * Value: An integer value specifying the top offset in twips.
*/
topDistance: number;
/**
* Gets or sets the bottom offset of text wrapping.
- * Value: An integer value specifying the bottom offset.
+ * Value: An integer value specifying the bottom offset in twips.
*/
bottomDistance: number;
}
@@ -13593,12 +14487,12 @@ interface FloatingObjectTextWrappingSettings {
interface FloatingObjectAbsoluteSizeSettings {
/**
* Gets or sets a floating object's absolute width.
- * Value: An integer value specifying the width.
+ * Value: An integer value specifying the width in twips.
*/
absoluteWidth: number;
/**
* Gets or sets a floating object's absolute height.
- * Value: An integer value specifying the height.
+ * Value: An integer value specifying the height in twips.
*/
absoluteHeight: number;
}
@@ -13710,6 +14604,16 @@ interface RedoCommand extends CommandWithSimpleStateBase {
*/
execute(): boolean;
}
+/**
+ * A command to add an HTML formatted content in place of a selected range.
+ */
+interface InsertHtmlCommand extends CommandWithSimpleStateBase {
+ /**
+ * Executes the InsertHtmlCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
+ * @param html A string that specifies the inserted HTML code.
+ */
+ execute(html: string): boolean;
+}
/**
* A command to invoke the Hyperlink dialog.
*/
@@ -13725,7 +14629,7 @@ interface OpenInsertHyperlinkDialogCommand extends CommandWithSimpleStateBase {
interface InsertHyperlinkCommand extends CommandBase {
/**
* Executes the InsertHyperlinkCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param settings A HyperLinkSettings object specifying hyperlink settings.
+ * @param settings A HyperlinkSettings object specifying hyperlink settings.
*/
execute(settings: HyperlinkSettings): boolean;
/**
@@ -14204,8 +15108,8 @@ interface ChangePictureScaleCommand extends CommandBase {
execute(scale: Scale): boolean;
/**
* Executes the ChangePictureScaleCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param x An interger number specifying width of the picture
- * @param y An interger number specifying height of the picture
+ * @param x An integer number specifying the scaling value for the width of the picture as a percentage.
+ * @param y An integer number specifying the scaling value for the height of the picture as a percentage.
*/
execute(x: number, y: number): boolean;
/**
@@ -14229,7 +15133,7 @@ interface MoveContentCommand extends CommandWithSimpleStateBase {
interface CopyContentCommand extends CommandWithSimpleStateBase {
/**
* Executes the CopyContentCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param position An integer number value specifying position for pasting selected text.
+ * @param position An integer value specifying a position of the inserted text.
*/
execute(position: number): boolean;
}
@@ -14242,6 +15146,15 @@ interface InsertTabCommand extends CommandWithSimpleStateBase {
*/
execute(): boolean;
}
+/**
+ * A command to add a non-breaking space in place of a selected range.
+ */
+interface InsertNonBreakingSpaceCommand extends CommandWithSimpleStateBase {
+ /**
+ * Executes the InsertNonBreakingSpaceCommand command by imitating the corresponding end-user action made in the RichEdit's UI. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
+ */
+ execute(): boolean;
+}
/**
* Defines the scaling settings.
*/
@@ -14263,10 +15176,10 @@ interface Scale {
interface ChangePageMarginsCommand extends CommandBase {
/**
* Executes the ChangePageMarginsCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param left An integer number specifying left margin of the page.
- * @param top An integer number specifying top margin of the page.
- * @param right An integer number specifying right margin of the page.
- * @param bottom An integer number specifying bottom margin of the page.
+ * @param left An integer number specifying left margin of the page in twips.
+ * @param top An integer number specifying top margin of the page in twips.
+ * @param right An integer number specifying right margin of the page in twips.
+ * @param bottom An integer number specifying bottom margin of the page in twips.
*/
execute(left: number, top: number, right: number, bottom: number): boolean;
/**
@@ -14326,8 +15239,8 @@ interface SetPageSizeDialogCommand extends CommandWithSimpleStateBase {
interface ChangePageSizeCommand extends CommandBase {
/**
* Executes the ChangePageSizeCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param width An integer number specifying width of the page.
- * @param height An integer number specifying height of the page.
+ * @param width An integer number specifying width of the page in twips.
+ * @param height An integer number specifying height of the page in twips.
*/
execute(width: number, height: number): boolean;
/**
@@ -14383,7 +15296,7 @@ interface ChangeSectionColumnsCommand extends CommandBase {
interface ChangePageColorCommand extends CommandBase {
/**
* Executes the ChangePageColorCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param color A string specifying a background color the page. May be specified as a color name or a hex color value.
+ * @param color A string specifying a background color of all pages contained in the document. May be specified as a color name or a hex color value.
*/
execute(color: string): boolean;
/**
@@ -14497,12 +15410,12 @@ interface CloseHeaderFooterCommand extends CommandWithSimpleStateBase {
interface SectionColumn {
/**
* Gets or sets the width of the section column.
- * Value: An integer value specifying the section column width.
+ * Value: An integer value specifying the section column width in twips.
*/
width: number;
/**
* Gets or sets the amount of space between adjacent section columns.
- * Value: An integer value specifying the spacing between section columns.
+ * Value: An integer value specifying the spacing after a column in twips.
*/
spacing: number;
}
@@ -14511,12 +15424,12 @@ interface SectionColumn {
*/
interface Size {
/**
- * Gets or sets the width value.
+ * Gets or sets the width value in twips.
* Value: An integer value specifying the width.
*/
width: number;
/**
- * Gets or sets the height value.
+ * Gets or sets the height value in twips.
* Value: An integer value specifying the height.
*/
height: number;
@@ -14527,22 +15440,22 @@ interface Size {
interface Margins {
/**
* Gets or sets the left margin.
- * Value: An integer value specifying the left margin.
+ * Value: An integer value specifying the left margin in twips.
*/
left: number;
/**
* Gets or sets the top margin.
- * Value: An integer value specifying the top margin.
+ * Value: An integer value specifying the top margin in twips.
*/
top: number;
/**
* Gets or sets the right margin.
- * Value: An integer value specifying the right margin.
+ * Value: An integer value specifying the right margin in twips.
*/
right: number;
/**
* Gets or sets the bottom margin.
- * Value: An integer value specifying the bottom margin.
+ * Value: An integer value specifying the bottom margin in twips.
*/
bottom: number;
}
@@ -14829,17 +15742,17 @@ interface ParagraphFormattingSettings {
*/
outlineLevel: number;
/**
- * Gets or sets the right indent value for the specified paragraph.
+ * Gets or sets the right indent value for the specified paragraph (in twips).
* Value: An integer value specifying the right indent.
*/
rightIndent: number;
/**
- * Gets or sets the spacing before the current paragraph.
+ * Gets or sets the spacing before each selected paragraph (in twips).
* Value: An integer value specifying the spacing before the paragraph.
*/
spacingBefore: number;
/**
- * Gets or sets the spacing after the current paragraph.
+ * Gets or sets the spacing after each selected paragraph (in twips).
* Value: An integer value specifying the spacing after the paragraph.
*/
spacingAfter: number;
@@ -14854,7 +15767,7 @@ interface ParagraphFormattingSettings {
*/
firstLineIndentType: any;
/**
- * Gets or sets a value specifying the indent of the first line of a paragraph.
+ * Gets or sets a value specifying the indent of the first line of a paragraph (in twips).
* Value: An integer value specifying the indent of the first line.
*/
firstLineIndent: number;
@@ -14874,12 +15787,12 @@ interface ParagraphFormattingSettings {
*/
pageBreakBefore: boolean;
/**
- * Gets or sets the left indent for text within a paragraph.
+ * Gets or sets the left indent for text within a paragraph (in twips).
* Value: An integer value specifying the left indent.
*/
leftIndent: number;
/**
- * Gets or sets a line spacing value.
+ * Gets or sets a line spacing value (in twips).
* Value: An integer value specifying the line spacing.
*/
lineSpacing: number;
@@ -14914,10 +15827,10 @@ declare enum ParagraphFirstLineIndent {
interface AssignShortcutCommand extends CommandWithSimpleStateBase {
/**
* Executes the AssignShortcutCommand command by applying the specified settings. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param keyCode An integer value specifying the code uniquely identifying the key combination.
- * @param callback A callback function to execute on pressing the shortcut.
+ * @param keyCode A specifically generated code that uniquely identifies the combination of keys specified for a shortcut. This code is specified using the GetShortcutCode method.
+ * @param callback A callback function to execute when a shortcut is activated.
*/
- execute(keyCode: number, callback: (arg1: string) => void): boolean;
+ execute(keyCode: number, callback: Function): boolean;
}
/**
* A command to invoke the Spelling dialog window.
@@ -15529,7 +16442,7 @@ interface TableBorderSettings {
*/
color: string;
/**
- * Gets or sets the border line width.
+ * Gets or sets the border line width in twips.
* Value: An integer value defining the border line width.
*/
width: number;
@@ -15752,22 +16665,22 @@ interface TableCellFormattingSettings {
*/
noWrap: boolean;
/**
- * Gets or sets a table cell's left margin.
+ * Gets or sets a table cell's left margin in twips.
* Value: An integer value specifying the left margin.
*/
marginLeft: number;
/**
- * Gets or sets a table cell's right margin.
+ * Gets or sets a table cell's right margin in twips.
* Value: An integer value specifying the right margin.
*/
marginRight: number;
/**
- * Gets or sets a table cell's top margin.
+ * Gets or sets a table cell's top margin in twips.
* Value: An integer value specifying the top margin.
*/
marginTop: number;
/**
- * Gets or sets a table cell's bottom margin.
+ * Gets or sets a table cell's bottom margin in twips.
* Value: An integer value specifying the bottom margin.
*/
marginBottom: number;
@@ -15798,12 +16711,12 @@ interface TableFormattingSettings {
*/
alignment: any;
/**
- * Gets or sets the table's left indent.
+ * Gets or sets the table's left indent in twips.
* Value: An integer value specifying the indent.
*/
indent: number;
/**
- * Gets or sets the spacing between table cells.
+ * Gets or sets the spacing between table cells in twips.
* Value: An integer value specifying the spacing.
*/
spacingBetweenCells: number;
@@ -15818,22 +16731,22 @@ interface TableFormattingSettings {
*/
resizeToFitContent: boolean;
/**
- * Gets or sets the default left margin for cells in the table.
+ * Gets or sets the default left margin for cells in the table in twips.
* Value: An integer value specifying the margin value.
*/
defaultCellMarginLeft: number;
/**
- * Gets or sets the default right margin for cells in the table.
+ * Gets or sets the default right margin for cells in the table in twips.
* Value: An integer value specifying the margin value.
*/
defaultCellMarginRight: number;
/**
- * Gets or sets the default top margin for cells in the table.
+ * Gets or sets the default top margin for cells in the table in twips.
* Value: An integer value specifying the margin value.
*/
defaultCellMarginTop: number;
/**
- * Gets or sets the default bottom margin for cells in the table.
+ * Gets or sets the default bottom margin for cells in the table in twips.
* Value: An integer value specifying the margin value.
*/
defaultCellMarginBottom: number;
@@ -15843,7 +16756,7 @@ interface TableFormattingSettings {
*/
interface TableWidthUnit {
/**
- * Gets or sets the table width value.
+ * Gets or sets the table width value in twips.
* Value: An integer value specifying the table width.
*/
value: number;
@@ -15858,7 +16771,7 @@ interface TableWidthUnit {
*/
interface TableHeightUnit {
/**
- * Gets or sets the table height value.
+ * Gets or sets the table height value in twips.
* Value: An integer value specifying the table height.
*/
value: number;
@@ -15907,7 +16820,7 @@ interface ChangeFontNameCommand extends CommandBase {
interface ChangeFontSizeCommand extends CommandBase {
/**
* Executes the ChangeFontSizeCommand command by applying the specified setting. May result in taking no action if the command's state does not allow command execution. Use the object's getState method to check the command state.
- * @param fontSize An integer number specifying the font size.
+ * @param fontSize An integer number specifying the font size in points.
*/
execute(fontSize: number): boolean;
/**
@@ -16161,7 +17074,7 @@ interface FontFormattingSettings {
*/
fontName: string;
/**
- * Gets or sets the character(s) font size.
+ * Gets or sets the character(s) font size (in points).
* Value: An integer value specifying the font size.
*/
size: number;
@@ -16197,7 +17110,7 @@ interface FontFormattingSettings {
italic: boolean;
/**
* Gets or sets a value specifying whether the strikeout formatting is applied to a character(s).
- * Value: true if the strikeout formatting is applied; otherwise, false.
+ * Value: true, if the strikeout formatting is applied; otherwise, false.
*/
strikeout: boolean;
/**
@@ -16972,7 +17885,7 @@ interface YearlyRecurrenceValuesAccessor extends DefaultRecurrenceRuleValuesAcce
GetWeekOfMonth(): ASPxClientWeekOfMonth;
}
/**
- * Provides base functionality for ASPxClientScheduler's forms.
+ * Provides base functionality for the ASPxClientScheduler's forms.
*/
interface ASPxClientFormBase {
/**
@@ -17201,6 +18114,10 @@ interface ASPxClientScheduler extends ASPxClientControl {
* Client-side event that fires before an appointment is deleted.
*/
AppointmentDeleting: ASPxClientEvent>;
+ /**
+ * Fires on the client side before the appointment tooltip is shown.
+ */
+ AppointmentToolTipShowing: ASPxClientEvent>;
/**
* Client-side scripting method that gets the active View.
*/
@@ -17265,6 +18182,24 @@ interface ASPxClientScheduler extends ASPxClientControl {
* Client-side function that returns the time interval, selected in the scheduler.
*/
GetSelectedInterval(): ASPxClientTimeInterval;
+ /**
+ * Selects time cells which encompass the specified time interval on the client side.
+ * @param interval An ASPxClientTimeInterval object that specifies the time interval to select.
+ */
+ SetSelection(interval: ASPxClientTimeInterval): void;
+ /**
+ * Selects time cells which encompass the specified time interval on the client side.
+ * @param interval An ASPxClientTimeInterval object that specifies the time interval to select.
+ * @param resourceId An integer value specifying the ID of the resource to which the specified time interval belongs.
+ */
+ SetSelection(interval: ASPxClientTimeInterval, resourceId: string): void;
+ /**
+ * Selects time cells which encompass the specified time interval on the client side.
+ * @param interval An ASPxClientTimeInterval object that specifies the time interval to select.
+ * @param resourceId An integer value specifying the ID of the resource to which the specified time interval belongs.
+ * @param scrollToSelection true, to scroll the scheduler's contents to make the selection visible; otherwise, false.
+ */
+ SetSelection(interval: ASPxClientTimeInterval, resourceId: string, scrollToSelection: boolean): void;
/**
* Client-side function that returns the ResourceId of selected time cell's resource.
*/
@@ -17292,6 +18227,12 @@ interface ASPxClientScheduler extends ASPxClientControl {
* @param aptId An appointment's identifier.
*/
SelectAppointmentById(aptId: Object): void;
+ /**
+ * Selects the appointment with the specified ID.
+ * @param aptId An integer value specifying the appointment ID.
+ * @param scrollToSelection true, to scroll to the selected appointment; otherwise, false.
+ */
+ SelectAppointmentById(aptId: Object, scrollToSelection: boolean): void;
/**
* Enables obtaining appointment property values in a client-side script. Executes the callback command with the AppointmentData identifier.
* @param aptId An integer, representing the appointment ID.
@@ -17439,6 +18380,42 @@ interface ASPxClientScheduler extends ASPxClientControl {
* Client-side scripting method that changes the alert time for the selected reminder to the specified interval.
*/
ReminderFormSnooze(): void;
+ /**
+ * Specifies whether the toolbar is visible.
+ * @param visible true, to make the toolbar visible; otherwise, false.
+ */
+ SetToolbarVisible(visible: boolean): void;
+ /**
+ * Returns a value specifying whether a toolbar is displayed.
+ */
+ GetToolbarVisible(): boolean;
+ /**
+ * Specifies whether the Resource Navigator is visible.
+ * @param visible true, to make the Resource Navigator visible; otherwise, false.
+ */
+ SetResourceNavigatorVisible(visible: boolean): void;
+ /**
+ * Returns a value specifying whether the Resource Navigator is displayed.
+ */
+ GetResourceNavigatorVisible(): boolean;
+ /**
+ * Returns the value specifying the Scheduler's scrollable area height.
+ */
+ GetScrollAreaHeight(): number;
+ /**
+ * Specifies the All-Day Area area height.
+ * @param height An integer value specifying the all-day area height.
+ */
+ SetAllDayAreaHeight(height: number): void;
+ /**
+ * Gets the All-Day Area area height.
+ */
+ GetAllDayAreaHeight(): number;
+ /**
+ * Sets the Scheduler's height.
+ * @param height An integer value specifying the scheduler's height.
+ */
+ SetHeight(height: number): void;
}
/**
* Represents a client-side equivalent of the SchedulerViewType object.
@@ -17923,6 +18900,27 @@ interface CellClickEventArgs extends ASPxClientEventArgs {
*/
resource: string;
}
+/**
+ * A method that will handle the client AppointmentToolTipShowing event.
+ */
+interface ASPxClientAppointmentToolTipShowingEventHandler {
+ /**
+ * A method that will handle the corresponding client event.
+ * @param source The event source.
+ * @param e An ASPxClientAppointmentToolTipShowingEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientAppointmentToolTipShowingEventArgs): void;
+}
+/**
+ * Provides data for the AppointmentToolTipShowing event.
+ */
+interface ASPxClientAppointmentToolTipShowingEventArgs extends ASPxClientCancelEventArgs {
+ /**
+ * Gets the appointment.
+ * Value: An ASPxClientAppointment object representing the appointment.
+ */
+ appointment: ASPxClientAppointment;
+}
/**
* Contains information about a client tooltip.
*/
@@ -17968,13 +18966,13 @@ interface ASPxClientToolTipBase {
*/
CalculatePosition(bounds: Object): ASPxClientPoint;
/**
- * Displays the Appointment Menu in the position of the tooltip.
- * @param eventObject An object containing information about the event on which the menu is displayed.
+ * Displays the Appointment Menu at the position of the tooltip.
+ * @param eventObject An object containing information about the event in which the menu is displayed.
*/
ShowAppointmentMenu(eventObject: Object): void;
/**
- * Displays the View Menu in the position of the tooltip.
- * @param eventObject An object containing information about the event on which the menu is displayed.
+ * Displays the View Menu at the position of the tooltip.
+ * @param eventObject An object containing information about the event in which the menu is displayed.
*/
ShowViewMenu(eventObject: Object): void;
/**
@@ -18579,6 +19577,20 @@ interface ASPxClientTreeList extends ASPxClientControl {
* Occurs after a column's width has been changed by an end-user.
*/
ColumnResized: ASPxClientEvent>;
+ /**
+ * Hides the Filter Control.
+ */
+ CloseFilterControl(): void;
+ /**
+ * Enables or disables the current filter.
+ * @param isFilterEnabled true to enable the current filter; otherwise, false.
+ */
+ SetFilterEnabled(isFilterEnabled: boolean): void;
+ /**
+ * Specifies a custom editor for the search panel on the client side.
+ * @param editor An ASPxClientEdit object representing a custom editor.
+ */
+ SetSearchPanelCustomEditor(editor: ASPxClientEdit): void;
/**
* Sets input focus to the ASPxTreeList.
*/
@@ -18973,6 +19985,66 @@ interface ASPxClientTreeList extends ASPxClientControl {
* @param position An integer value specifying the horizontal scroll position.
*/
SetHorizontalScrollPosition(position: number): void;
+ /**
+ * Exports tree list data to a file in the specified format.
+ * @param format An ASPxClientTreeListExportFormat object specifying the export format.
+ */
+ ExportTo(format: ASPxClientTreeListExportFormat): void;
+ /**
+ * Applies the specified filter expression to the tree list.
+ * @param filterExpression A string value that specifies the filter expression.
+ */
+ ApplyFilter(filterExpression: string): void;
+ /**
+ * Clears the filter expression applied to a client Tree List.
+ */
+ ClearFilter(): void;
+ /**
+ * Applies a filter specified in the filter row to the ASPxTreeList.
+ */
+ ApplyOnClickRowFilter(): void;
+ /**
+ * Applies the specified search panel filter criterion to tree list data.
+ * @param value A string value that specifies the filter criterion.
+ */
+ ApplySearchPanelFilter(value: string): void;
+ /**
+ * Returns the editor used to edit the value in the auto filter row for the specified data column.
+ * @param column An ASPxClientTreeListColumn object that represents the data column within the ASPxTreeList.
+ */
+ GetAutoFilterEditor(column: ASPxClientTreeListColumn): Object;
+ /**
+ * Returns the editor used to edit the value in the auto filter row for the specified data column.
+ * @param columnIndex An integer value that identifies the data column by its index.
+ */
+ GetAutoFilterEditor(columnIndex: number): Object;
+ /**
+ * Returns the editor used to edit the value in the auto filter row for the specified data column.
+ * @param columnFieldNameOrId A string value that specifies the column's name or its data base field name.
+ */
+ GetAutoFilterEditor(columnFieldNameOrId: string): Object;
+ /**
+ * Applies a filter to the specified data column.
+ * @param column An ASPxClientTreeListColumn object that represents the data column within the client Tree List.
+ * @param val A string value that specifies the filter expression.
+ */
+ AutoFilterByColumn(column: ASPxClientTreeListColumn, val: string): void;
+ /**
+ * Applies a filter to the specified data column.
+ * @param columnIndex An integer value that specifies the column's position within the column collection.
+ * @param val A string value that specifies the filter expression.
+ */
+ AutoFilterByColumn(columnIndex: number, val: string): void;
+ /**
+ * Applies a filter to the specified data column.
+ * @param columnFieldNameOrId A string value that specifies the column's field name or unique identifier (the column's Name property value).
+ * @param val A string value that specifies the filter expression.
+ */
+ AutoFilterByColumn(columnFieldNameOrId: string, val: string): void;
+ /**
+ * Displays the Filter Control.
+ */
+ ShowFilterControl(): void;
}
/**
* Represents a client column.
@@ -18994,6 +20066,11 @@ interface ASPxClientTreeListColumn {
*/
fieldName: string;
}
+/**
+ * Lists values that specify the document formats available for export from the tree list.
+ */
+interface ASPxClientTreeListExportFormat {
+}
/**
* Provides data for the CustomDataCallback event.
*/
@@ -19227,8 +20304,8 @@ interface ASPxClientTreeListToolbarItemClickEventArgs extends ASPxClientProcessi
*/
toolbarName: string;
/**
- * Gets the toolbar item related to the event.
- * Value: An ASPxClientMenuItem object that is the toolbar item.
+ * Gets the clicked menu item
+ * Value: An ASPxClientMenu value that is the menu item.
*/
item: ASPxClientMenuItem;
/**
@@ -19252,7 +20329,241 @@ interface ASPxClientTreeListToolbarItemClickEventHandler {
* Represents a client-side equivalent of the BootstrapAccordion control.
*/
interface BootstrapClientAccordion extends ASPxClientNavBar {
+ /**
+ * Returns a group specified by its index.
+ * @param index An integer value specifying the zero-based index of the group object to retrieve.
+ */
+ GetGroup(index: number): BootstrapClientAccordionGroup;
+ /**
+ * Returns a group specified by its name.
+ * @param name A string value specifying the name of the group.
+ */
+ GetGroupByName(name: string): BootstrapClientAccordionGroup;
+ /**
+ * Returns the Accordion control's active group.
+ */
+ GetActiveGroup(): BootstrapClientAccordionGroup;
+ /**
+ * Makes the specified group active.
+ * @param group A BootstrapClientAccordionGroup object that specifies the active group.
+ */
+ SetActiveGroup(group: BootstrapClientAccordionGroup): void;
+ /**
+ * Returns an item specified by its name.
+ * @param name A string value specifying the name of the item.
+ */
+ GetItemByName(name: string): BootstrapClientAccordionItem;
+ /**
+ * Returns the selected item within the Accordion control.
+ */
+ GetSelectedItem(): BootstrapClientAccordionItem;
+ /**
+ * Selects the specified item within the Accordion control on the client side.
+ * @param item A BootstrapClientAccordionItem object specifying the item to select.
+ */
+ SetSelectedItem(item: BootstrapClientAccordionItem): void;
+ /**
+ * Makes the specified group active.
+ * @param group A ASPxClientNavBarGroup object that specifies the active group.
+ */
+ SetActiveGroup(group: ASPxClientNavBarGroup): void;
+ /**
+ * Selects the specified item within the navbar control on the client side.
+ * @param item An ASPxClientNavBarItem object specifying the item to select.
+ */
+ SetSelectedItem(item: ASPxClientNavBarItem): void;
}
+/**
+ * Represents a client-side equivalent of the Accordion's BootstrapAccordionGroup object.
+ */
+interface BootstrapClientAccordionGroup extends ASPxClientNavBarGroup {
+ /**
+ * Gets the BootstrapClientAccordion object to which the current group belongs.
+ * Value: A object that is the group's owner.
+ */
+ navBar: BootstrapClientAccordion;
+ /**
+ * Returns the group's item specified by its index.
+ * @param index An integer value specifying the zero-based index of the item to be retrieved.
+ */
+ GetItem(index: number): BootstrapClientAccordionItem;
+ /**
+ * Returns a group item specified by its name.
+ * @param name A string value specifying the name of the item.
+ */
+ GetItemByName(name: string): BootstrapClientAccordionItem;
+ /**
+ * Gets the text displayed within an accordion group header badge.
+ */
+ GetHeaderBadgeText(): string;
+ /**
+ * Sets the text displayed within an accordion group header badge.
+ * @param text A String specifying the badge text.
+ */
+ SetHeaderBadgeText(text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within an accordion group header badge.
+ */
+ GetHeaderBadgeIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed within an accordion group header badge.
+ * @param cssClass A String containing the name of a CSS class.
+ */
+ SetHeaderBadgeIconCssClass(cssClass: string): void;
+}
+/**
+ * Represents a client-side equivalent of the Accordion's BootstrapAccordionItem object.
+ */
+interface BootstrapClientAccordionItem extends ASPxClientNavBarItem {
+ /**
+ * Gets the BootstrapClientAccordion object to which the current item belongs.
+ * Value: A object that is the item's owner.
+ */
+ navBar: BootstrapClientAccordion;
+ /**
+ * Gets the group to which the current item belongs.
+ * Value: A object representing the group to which the item belongs.
+ */
+ group: BootstrapClientAccordionGroup;
+ /**
+ * Gets the text displayed within the accordion item badge.
+ */
+ GetBadgeText(): string;
+ /**
+ * Sets the text displayed within the accordion item badge.
+ * @param text A String specifying the badge text.
+ */
+ SetBadgeText(text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within the accordion item badge.
+ */
+ GetBadgeIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed within the accordion item badge.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetBadgeIconCssClass(cssClass: string): void;
+ /**
+ * Specifies the URL which points to the image displayed within the item.
+ */
+ GetImageUrl(): string;
+ /**
+ * Specifies the URL which points to the image displayed within the item.
+ * @param value
+ */
+ SetImageUrl(value: string): void;
+ /**
+ * Gets the CSS class of the icon displayed by the Accordion item.
+ */
+ GetIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed by the Accordion item.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetIconCssClass(cssClass: string): void;
+}
+/**
+ * A method that will handle the Accordion control's client events concerning manipulations with an item.
+ */
+interface BootstrapClientAccordionItemEventHandler {
+ /**
+ * A method that will handle the Accordion control's client events concerning manipulations with an item.
+ * @param source An object representing the event source. Identifies the BootstrapClientAccordion control that raised the event.
+ * @param e An BootstrapClientAccordionItemEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientAccordionItemEventArgs): void;
+}
+/**
+ * Provides data for events related to manipulations on items.
+ */
+interface BootstrapClientAccordionItemEventArgs extends ASPxClientProcessingModeEventArgs {
+ /**
+ * Gets the item object related to the event.
+ * Value: A BootstrapClientAccordionItem object, manipulations on which forced the event to be raised.
+ */
+ item: BootstrapClientAccordionItem;
+ /**
+ * Gets an HTML object that contains the processed Accordion item.
+ * Value: An HTML object.
+ */
+ htmlElement: Object;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: A DHTML event object.
+ */
+ htmlEvent: Object;
+}
+/**
+ * A method that will handle the Accordion control's client events concerning manipulations with a group.
+ */
+interface BootstrapClientAccordionGroupEventHandler {
+ /**
+ * A method that will handle the Accordion control's client events concerning manipulations with a group.
+ * @param source An object representing the event source. Identifies the BootstrapClientAccordion control that raised the event.
+ * @param e An BootstrapClientAccordionGroupEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientAccordionGroupEventArgs): void;
+}
+/**
+ * Provides data for events related to manipulations on groups.
+ */
+interface BootstrapClientAccordionGroupEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the group object related to the event.
+ * Value: A BootstrapClientAccordionGroup object, manipulations on which forced the event to be raised.
+ */
+ group: BootstrapClientAccordionGroup;
+}
+/**
+ * A method that will handle the Accordion control's cancelable client events concerning manipulations with a group.
+ */
+interface BootstrapClientAccordionGroupCancelEventHandler {
+ /**
+ * A method that will handle the Accordion control's cancelable client events concerning manipulations with a group.
+ * @param source An object representing the event source. Identifies the BootstrapClientAccordion control that raised the event.
+ * @param e An BootstrapClientAccordionGroupCancelEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientAccordionGroupCancelEventArgs): void;
+}
+/**
+ * Provides data for events related to manipulations on accordion groups.
+ */
+interface BootstrapClientAccordionGroupCancelEventArgs extends ASPxClientProcessingModeCancelEventArgs {
+ /**
+ * Gets the group object related to the event.
+ * Value: A BootstrapClientAccordionGroup object, manipulations on which forced the event to be raised.
+ */
+ group: BootstrapClientAccordionGroup;
+}
+/**
+ * A method that will handle the Accordion control's client events concerning clicks on groups.
+ */
+interface BootstrapClientAccordionGroupClickEventHandler {
+ /**
+ * A method that will handle the Accordion control's client events concerning clicks on groups.
+ * @param source An object representing the event source. Identifies the BootstrapClientAccordion control that raised the event.
+ * @param e An BootstrapClientAccordionGroupClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientAccordionGroupClickEventArgs): void;
+}
+/**
+ * Provides data for events related to clicking on the control's group headers.
+ */
+interface BootstrapClientAccordionGroupClickEventArgs extends BootstrapClientAccordionGroupCancelEventArgs {
+ /**
+ * Gets an HTML object that contains the processed Accordion group.
+ * Value: An HTML object.
+ */
+ htmlElement: Object;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: A DHTML event object.
+ */
+ htmlEvent: Object;
+}
+/**
+ * Represents the client-side equivalent of the BootstrapBinaryImage control.
+ */
interface BootstrapClientBinaryImage extends ASPxClientHyperLink {
}
/**
@@ -19268,6 +20579,24 @@ interface BootstrapClientButton extends ASPxClientButton {
* @param value A string value specifying the text to be displayed within the button.
*/
SetText(value: string): void;
+ /**
+ * Gets the text displayed within the button badge.
+ */
+ GetBadgeText(): string;
+ /**
+ * Sets the text displayed within the button badge.
+ * @param text A String specifying the badge text.
+ */
+ SetBadgeText(text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within the button badge.
+ */
+ GetBadgeIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed within the button badge.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetBadgeIconCssClass(cssClass: string): void;
}
/**
* Represents a client-side equivalent of the BootstrapCalendar control.
@@ -19320,92 +20649,12 @@ interface BootstrapClientCallbackPanel extends ASPxClientControl {
*/
GetEnabled(): boolean;
}
-/**
- * Serves as the base type for the BootstrapClientPieChart objects.
- */
-interface BootstrapClientChartBase extends ASPxClientControl {
- Done: ASPxClientEvent>;
- LegendClick: ASPxClientEvent>;
- PointClick: ASPxClientEvent>;
- PointHoverChanged: ASPxClientEvent>;
- PointSelectionChanged: ASPxClientEvent>;
- TooltipHidden: ASPxClientEvent>;
- TooltipShown: ASPxClientEvent>;
- ArgumentAxisClick: ASPxClientEvent>;
- SeriesClick: ASPxClientEvent>;
- SeriesHoverChanged: ASPxClientEvent>;
- SeriesSelectionChanged: ASPxClientEvent>;
-}
-/**
- * Represents a client-side equivalent of the BootstrapChart control.
- */
-interface BootstrapClientChart extends BootstrapClientChartBase {
- ZoomStart: ASPxClientEvent>;
- ZoomEnd: ASPxClientEvent>;
-}
-/**
- * Represents a client-side equivalent of the BootstrapPolarChart control.
- */
-interface BootstrapClientPolarChart extends BootstrapClientChartBase {
-}
-/**
- * Represents a client-side equivalent of the BootstrapPieChart control.
- */
-interface BootstrapClientPieChart extends BootstrapClientChartBase {
-}
-interface BootstrapClientChartBaseDoneEventHandler {
- (source: S, e: BootstrapUIWidgetEventArgsBase): void;
-}
-interface BootstrapClientChartBaseLegendClickEventHandler {
- (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
-}
-interface BootstrapClientCoordinateSystemChartArgumentAxisClickEventHandler {
- (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
-}
-interface BootstrapClientChartBasePointClickEventHandler {
- (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
-}
-interface BootstrapClientChartBasePointHoverChangedEventHandler {
- (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
-}
-interface BootstrapClientChartBasePointSelectionChangedEventHandler {
- (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
-}
-interface BootstrapClientChartBaseTooltipHiddenEventHandler {
- (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
-}
-interface BootstrapClientChartBaseTooltipShownEventHandler {
- (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
-}
-interface BootstrapClientCoordinateSystemChartSeriesClickEventHandler {
- (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
-}
-interface BootstrapClientCoordinateSystemChartSeriesHoverChangedEventHandler {
- (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
-}
-interface BootstrapClientCoordinateSystemChartSeriesSelectionChangedEventHandler {
- (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
-}
-interface BootstrapClientChartZoomStartEventHandler {
- (source: S, e: BootstrapUIWidgetEventArgsBase): void;
-}
-interface BootstrapClientChartZoomEndEventHandler {
- (source: S, e: BootstrapClientChartZoomEndEventArgs): void;
-}
-interface BootstrapUIWidgetEventArgsBase extends ASPxClientEventArgs {
- component: Object;
- element: Object;
-}
-interface BootstrapClientChartZoomEndEventArgs extends BootstrapUIWidgetEventArgsBase {
- rangeStart: Object;
- rangeEnd: Object;
-}
/**
* Represents a client-side equivalent of the BootstrapCheckBox control.
*/
interface BootstrapClientCheckBox extends ASPxClientEdit {
/**
- * Occurs on the client side when the editor's checked state is changed.
+ * Occurs on the client side when the editor's checked state has been changed.
*/
CheckedChanged: ASPxClientEvent>;
/**
@@ -19414,7 +20663,7 @@ interface BootstrapClientCheckBox extends ASPxClientEdit {
GetChecked(): boolean;
/**
* Sets a value which specifies the checked status of the check box editor.
- * @param isChecked
+ * @param isChecked true if the check box editor is checked; otherwise, false.
*/
SetChecked(isChecked: boolean): void;
/**
@@ -19427,12 +20676,12 @@ interface BootstrapClientCheckBox extends ASPxClientEdit {
GetCheckState(): string;
/**
* Sets a value specifying the state of a check box.
- * @param checkState
+ * @param checkState A string value matches one of the CheckState enumeration values.
*/
SetCheckState(checkState: string): void;
/**
* Sets the text to be displayed within the editor.
- * @param text
+ * @param text A string value specifying the text to be displayed within the editor.
*/
SetText(text: string): void;
}
@@ -19450,103 +20699,125 @@ interface BootstrapClientComboBox extends ASPxClientComboBox {
*/
GetSelectedItem(): BootstrapClientListBoxItem;
/**
- * Sets the combo box editor's selected item.
- * @param item
+ * Sets the list editor's selected item.
+ * @param item A BootstrapClientListBoxItem object that specifies the item to select.
*/
SetSelectedItem(item: BootstrapClientListBoxItem): void;
/**
* Returns an item specified by its index within the combo box editor's item collection.
- * @param index
+ * @param index An integer value specifying the zero-based index of the item to search for.
*/
GetItem(index: number): BootstrapClientListBoxItem;
/**
* Returns a combo box item by its text.
- * @param text
+ * @param text A string that specifies the item's text.
*/
FindItemByText(text: string): BootstrapClientListBoxItem;
/**
* Returns a combo box item by its value.
- * @param value
+ * @param value An object that specifies the item's value.
*/
FindItemByValue(value: Object): BootstrapClientListBoxItem;
/**
- * Adds a new item to the editor, specifying the item's display text, and returns the index of the added item.
+ * Adds a new item to the end of the editor's items collection, specifying the item's display text, and returns the index of the added item.
* @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
*/
AddItem(texts: string[]): number;
/**
* Adds a new item to the end of the control's items collection.
- * @param texts
- * @param value
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
*/
AddItem(texts: string[], value: Object): number;
/**
* Adds a new item to the end of the control's items collection.
- * @param texts
- * @param value
- * @param iconCssClass
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
AddItem(texts: string[], value: Object, iconCssClass: string): number;
/**
- * Adds a new item to the editor specifying the item's display text and returns the index of the added item.
- * @param text
+ * Adds a new item to the editor, specifying the item's display text, and returns the index of the added item.
+ * @param text A string value specifying the item's display text.
*/
AddItem(text: string): number;
/**
- * Adds a new item to the editor specifying the item's display text and associated value, and returns the index of the added item.
- * @param text
- * @param value
+ * Adds a new item to the editor, specifying the item's display text and associated value, and returns the index of the added item.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
*/
AddItem(text: string, value: Object): number;
/**
- * Adds a new item to the editor specifying the item's display text, associated value and displayed image, and returns the index of the added item.
- * @param text
- * @param value
- * @param iconCssClass
+ * Adds a new item to the editor, specifying the item's display text, associated value and displayed image, and returns the index of the added item.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
AddItem(text: string, value: Object, iconCssClass: string): number;
/**
- * Adds a new item to the control's items collection at the specified index.
- * @param index
- * @param texts
- * @param value
- * @param iconCssClass
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding field within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
InsertItem(index: number, texts: string[], value: Object, iconCssClass: string): void;
/**
- * Adds a new item to the control's items collection at the specified index.
- * @param index
- * @param texts
- * @param value
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
*/
InsertItem(index: number, texts: string[], value: Object): void;
/**
- * Adds a new item to the control's items collection at the specified index.
- * @param index
- * @param texts
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
*/
InsertItem(index: number, texts: string[]): void;
/**
- * Adds a new item to the control's items collection at the specified index.
- * @param index
- * @param text
- * @param value
- * @param iconCssClass
+ * Inserts a new item specified by its display text, associated value and displayed image into the editor's item collection, at the position specified.
+ * @param index An integer value that represents the index position.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
InsertItem(index: number, text: string, value: Object, iconCssClass: string): void;
/**
- * Inserts a new item specified by its display text and associated value into the editor's item collection, at the position specified.
- * @param index
- * @param text
- * @param value
+ * Inserts a new item specified by its display text, associated value and displayed image into the editor's item collection, at the position specified.
+ * @param index An integer value that represents the index position.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
*/
InsertItem(index: number, text: string, value: Object): void;
/**
- * Inserts a new item specified by its display text into the editor's item collection, at the position specified.
- * @param index
- * @param text
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param text A string value specifying the item's display text.
*/
InsertItem(index: number, text: string): void;
+ /**
+ * Gets the text displayed within a Combo Box item badge.
+ * @param index The index of a Combo Box item.
+ */
+ GetItemBadgeText(index: number): string;
+ /**
+ * Sets the text displayed within a Combo Box item badge.
+ * @param index The index of a Combo Box item.
+ * @param text A String specifying the badge text.
+ */
+ SetItemBadgeText(index: number, text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within a Combo Box item badge.
+ * @param index The index of a Combo Box item.
+ */
+ GetItemBadgeIconCssClass(index: number): string;
+ /**
+ * Sets the CSS class of the icon displayed within a Combo Box item badge.
+ * @param index The index of a Combo Box item.
+ * @param cssClass A String containing the name of a CSS class.
+ */
+ SetItemBadgeIconCssClass(index: number, cssClass: string): void;
/**
* Sets the list editor's selected item.
* @param item An ASPxClientListEditItem object that specifies the item to select.
@@ -19572,7 +20843,28 @@ interface BootstrapClientFormLayout extends ASPxClientFormLayout {
* Represents a client-side equivalent of the BootstrapHyperLink control.
*/
interface BootstrapClientHyperLink extends ASPxClientHyperLink {
+ /**
+ * Gets the text displayed within the hyperlink badge.
+ */
+ GetBadgeText(): string;
+ /**
+ * Sets the text displayed within the hyperlink badge.
+ * @param text A String specifying the badge text.
+ */
+ SetBadgeText(text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within the hyperlink badge.
+ */
+ GetBadgeIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed within the hyperlink badge.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetBadgeIconCssClass(cssClass: string): void;
}
+/**
+ * Represents the client-side equivalent of the BootstrapImage control.
+ */
interface BootstrapClientImage extends ASPxClientImage {
}
/**
@@ -19583,6 +20875,10 @@ interface BootstrapClientListBoxItem extends ASPxClientListEditItem {
* This member is not in effect for this class. It is overridden only for the purpose of preventing it from appearing in Microsoft Visual Studio designer tools.
*/
imageUrl: string;
+ /**
+ * Gets the CSS class of the icon displayed by the list box item.
+ * Value: A string containing the name of a CSS class.
+ */
iconCssClass: string;
/**
*
@@ -19595,13 +20891,13 @@ interface BootstrapClientListBoxItem extends ASPxClientListEditItem {
*/
GetColumnText(columnName: string): string;
/**
- *
- * @param fieldIndex
+ * Returns the list item's text value that corresponds to a data field specified by its index.
+ * @param fieldIndex An integer value that specifies the field's index within the editor's Fields collection.
*/
GetFieldText(fieldIndex: number): string;
/**
- *
- * @param fieldName
+ * Returns the list item's text value that corresponds to a data field specified by its name.
+ * @param fieldName A string value that specifies the data field's name defined via a FieldName property.
*/
GetFieldText(fieldName: string): string;
}
@@ -19610,17 +20906,17 @@ interface BootstrapClientListBoxItem extends ASPxClientListEditItem {
*/
interface BootstrapClientListBox extends ASPxClientListBox {
/**
- * Returns the list box editor's selected item.
+ * Returns the list editor's selected item.
*/
GetSelectedItem(): BootstrapClientListBoxItem;
/**
- * Sets the list box editor's selected item.
- * @param item
+ * Sets the list editor's selected item.
+ * @param item A BootstrapClientListBoxItem object that specifies the item to select.
*/
SetSelectedItem(item: BootstrapClientListBoxItem): void;
/**
* Returns an item specified by its index within the list box editor's item collection.
- * @param index
+ * @param index An integer value specifying the zero-based index of the item to search for.
*/
GetItem(index: number): BootstrapClientListBoxItem;
/**
@@ -19629,102 +20925,124 @@ interface BootstrapClientListBox extends ASPxClientListBox {
GetSelectedItems(): BootstrapClientListBoxItem[];
/**
* Selects the specified items within a list box.
- * @param items
+ * @param items An array of BootstrapClientListBoxItem objects that represent the items.
*/
SelectItems(items: BootstrapClientListBoxItem[]): void;
/**
* Unselects an array of the specified list box items.
- * @param items
+ * @param items An array of BootstrapClientListBoxItem objects that represent the items.
*/
UnselectItems(items: BootstrapClientListBoxItem[]): void;
/**
* Returns a list box item by its text.
- * @param text
+ * @param text A string that specifies the item's text.
*/
FindItemByText(text: string): BootstrapClientListBoxItem;
/**
* Returns a list box item by its value.
- * @param value
+ * @param value An object that specifies the item's value.
*/
FindItemByValue(value: Object): BootstrapClientListBoxItem;
/**
* Adds a new item to the end of the editor's items collection, specifying the item's display text, and returns the index of the added item.
- * @param texts
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
*/
AddItem(texts: string[]): number;
/**
* Adds a new item to the end of the control's items collection.
- * @param texts
- * @param value
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
*/
AddItem(texts: string[], value: Object): number;
/**
* Adds a new item to the end of the control's items collection.
- * @param texts
- * @param value
- * @param iconCssClass
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
AddItem(texts: string[], value: Object, iconCssClass: string): number;
/**
* Adds a new item to the editor, specifying the item's display text, and returns the index of the added item.
- * @param text
+ * @param text A string value specifying the item's display text.
*/
AddItem(text: string): number;
/**
* Adds a new item to the editor, specifying the item's display text and associated value, and returns the index of the added item.
- * @param text
- * @param value
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
*/
AddItem(text: string, value: Object): number;
/**
* Adds a new item to the editor, specifying the item's display text, associated value and displayed image, and returns the index of the added item.
- * @param text
- * @param value
- * @param iconCssClass
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
AddItem(text: string, value: Object, iconCssClass: string): number;
/**
- * Adds a new item to the control's items collection at the specified index.
- * @param index
- * @param texts
- * @param value
- * @param iconCssClass
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding field within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
InsertItem(index: number, texts: string[], value: Object, iconCssClass: string): void;
/**
- * Adds a new item to the control's items collection at the specified index.
- * @param index
- * @param texts
- * @param value
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
+ * @param value An object that represents the item's associated value.
*/
InsertItem(index: number, texts: string[], value: Object): void;
/**
- * Adds a new item to the control's items collection at the specified index.
- * @param index
- * @param texts
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param texts An array of strings that specifies the item's display text. Array element positions relate to the positions of the corresponding fields within the editor's Fields collection.
*/
InsertItem(index: number, texts: string[]): void;
/**
* Inserts a new item specified by its display text, associated value and displayed image into the editor's item collection, at the position specified.
- * @param index
- * @param text
- * @param value
- * @param iconCssClass
+ * @param index An integer value that represents the index position.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
*/
InsertItem(index: number, text: string, value: Object, iconCssClass: string): void;
/**
* Inserts a new item specified by its display text and associated value into the editor's item collection, at the position specified.
- * @param index
- * @param text
- * @param value
+ * @param index An integer value representing the zero-based index of the position where the item should be inserted.
+ * @param text A string value specifying the item's display text.
+ * @param value An object specifying the value associated with the item.
*/
InsertItem(index: number, text: string, value: Object): void;
/**
* Inserts a new item specified by its display text into the editor's item collection, at the position specified.
- * @param index
- * @param text
+ * @param index An integer value representing the zero-based index of the position where the item should be inserted.
+ * @param text A string value specifying the item's display text.
*/
InsertItem(index: number, text: string): void;
+ /**
+ * Gets the text displayed within a List Box item badge.
+ * @param index The index of a List Box item.
+ */
+ GetItemBadgeText(index: number): string;
+ /**
+ * Sets the text displayed within a List Box item badge.
+ * @param index The index of a List Box item.
+ * @param text A String specifying the badge text.
+ */
+ SetItemBadgeText(index: number, text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within a List Box item badge.
+ * @param index The index of a List Box item.
+ */
+ GetItemBadgeIconCssClass(index: number): string;
+ /**
+ * Sets the CSS class of the icon displayed within a List Box item badge.
+ * @param index The index of a List Box item.
+ * @param cssClass A String containing the name of a CSS class.
+ */
+ SetItemBadgeIconCssClass(index: number, cssClass: string): void;
/**
* Selects the specified items within a list box.
* @param items An array of ASPxClientListEditItem objects that represent the items.
@@ -19751,10 +21069,162 @@ interface BootstrapClientCheckBoxList extends ASPxClientCheckBoxList {
*/
interface BootstrapClientRadioButtonList extends ASPxClientRadioButtonList {
}
+/**
+ * Represents a client-side equivalent of the menu's BootstrapMenuItem object.
+ */
+interface BootstrapClientMenuItem extends ASPxClientMenuItem {
+ /**
+ * Gets the immediate parent item to which the current item belongs.
+ * Value: A BootstrapClientMenuItem object representing the item's immediate parent.
+ */
+ parent: BootstrapClientMenuItem;
+ /**
+ * Returns the current menu item's immediate subitem specified by its index.
+ * @param index An integer value specifying the zero-based index of the submenu item to be retrieved.
+ */
+ GetItem(index: number): BootstrapClientMenuItem;
+ /**
+ * Returns the current menu item's subitem specified by its name.
+ * @param name A string value specifying the name of the menu item.
+ */
+ GetItemByName(name: string): BootstrapClientMenuItem;
+ /**
+ * Gets the text displayed within the menu item badge.
+ */
+ GetBadgeText(): string;
+ /**
+ * Sets the text displayed within the menu item badge.
+ * @param text A String specifying the badge text.
+ */
+ SetBadgeText(text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within the menu item badge.
+ */
+ GetBadgeIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed within the menu item badge.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetBadgeIconCssClass(cssClass: string): void;
+ /**
+ * Returns the URL pointing to the image displayed within the menu item.
+ */
+ GetImageUrl(): string;
+ /**
+ * Sets the URL which points to the image displayed within the menu item.
+ * @param value
+ */
+ SetImageUrl(value: string): void;
+ /**
+ * Gets the CSS class of the icon displayed by the menu item.
+ */
+ GetIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed by the menu item.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetIconCssClass(cssClass: string): void;
+}
/**
* Represents a client-side equivalent of the BootstrapMenu control.
*/
interface BootstrapClientMenu extends ASPxClientMenu {
+ /**
+ * Returns the menu's root menu item specified by its index.
+ * @param index An integer value specifying the zero-based index of the root menu item to be retrieved.
+ */
+ GetItem(index: number): BootstrapClientMenuItem;
+ /**
+ * Returns a menu item specified by its name.
+ * @param name A string value specifying the name of the menu item.
+ */
+ GetItemByName(name: string): BootstrapClientMenuItem;
+ /**
+ * Returns the selected item within the menu control.
+ */
+ GetSelectedItem(): BootstrapClientMenuItem;
+ /**
+ * Selects the specified menu item within the Menu control on the client side.
+ * @param item A BootstrapClientMenuItem object specifying the menu item to select.
+ */
+ SetSelectedItem(item: BootstrapClientMenuItem): void;
+ /**
+ * Returns a root menu item.
+ */
+ GetRootItem(): BootstrapClientMenuItem;
+ /**
+ * Selects the specified menu item within a menu control on the client side.
+ * @param item An ASPxClientMenuItem object specifying the menu item to select.
+ */
+ SetSelectedItem(item: ASPxClientMenuItem): void;
+}
+/**
+ * A method that will handle the menu's client events concerning manipulations with an item.
+ */
+interface BootstrapClientMenuItemEventHandler {
+ /**
+ * A method that will handle the menu's client events concerning manipulations with an item.
+ * @param source An object representing the event source. Identifies the BootstrapMenu control that raised the event.
+ * @param e An BootstrapClientMenuItemEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientMenuItemEventArgs): void;
+}
+/**
+ * Provides data for events related to manipulations on menu items.
+ */
+interface BootstrapClientMenuItemEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the menu item object related to the event.
+ * Value: A BootstrapClientMenuItem object, manipulations on which forced the event to be raised.
+ */
+ item: BootstrapClientMenuItem;
+}
+/**
+ * A method that will handle the ItemMouseOver events.
+ */
+interface BootstrapClientMenuItemMouseEventHandler {
+ /**
+ * A method that will handle the ItemMouseOver events.
+ * @param source An object representing the event source. Identifies the BootstrapMenu control that raised the event.
+ * @param e An BootstrapClientMenuItemMouseEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientMenuItemMouseEventArgs): void;
+}
+/**
+ * Provides data for client events related to mouse hovering over menu items.
+ */
+interface BootstrapClientMenuItemMouseEventArgs extends BootstrapClientMenuItemEventArgs {
+}
+/**
+ * A method that will handle client ItemClick events.
+ */
+interface BootstrapClientMenuItemClickEventHandler {
+ /**
+ * A method that will handle client ItemClick events.
+ * @param source An object representing the event source. Identifies the BootstrapMenu control that raised the event.
+ * @param e An BootstrapClientMenuItemClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientMenuItemClickEventArgs): void;
+}
+/**
+ * Provides data for events related to clicking on the control's items.
+ */
+interface BootstrapClientMenuItemClickEventArgs extends ASPxClientProcessingModeEventArgs {
+ /**
+ * Gets the menu item object related to the event.
+ * Value: A BootstrapClientMenuItem object, manipulations on which forced the event to be raised.
+ */
+ item: BootstrapClientMenuItem;
+ /**
+ * Gets an HTML object that contains the processed Menu item.
+ * Value: An HTML object.
+ */
+ htmlElement: Object;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: A DHTML event object.
+ */
+ htmlEvent: Object;
}
/**
* Represents a client-side equivalent of the BootstrapPager control.
@@ -19766,8 +21236,8 @@ interface BootstrapClientPager extends ASPxClientPager {
*/
interface BootstrapClientPopupControl extends ASPxClientPopupControl {
/**
- *
- * @param selector
+ * Sets the CSS selector of a web control or HTML element with which the current popup window is associated.
+ * @param selector A string value specifying the CSS selector of the web control or HTML element with which the popup window is associated.
*/
SetPopupElementCssSelector(selector: string): void;
}
@@ -19776,10 +21246,38 @@ interface BootstrapClientPopupControl extends ASPxClientPopupControl {
*/
interface BootstrapClientPopupMenu extends ASPxClientPopupMenu {
/**
- *
- * @param selector
+ * Returns the popup menu's root menu item specified by its index.
+ * @param index An integer value specifying the zero-based index of the root menu item to be retrieved.
+ */
+ GetItem(index: number): BootstrapClientMenuItem;
+ /**
+ * Returns a menu item specified by its name.
+ * @param name A string value specifying the name of the menu item.
+ */
+ GetItemByName(name: string): BootstrapClientMenuItem;
+ /**
+ * Returns the selected item within the menu control.
+ */
+ GetSelectedItem(): BootstrapClientMenuItem;
+ /**
+ * Selects the specified menu item within a the Popup Menu control on the client side.
+ * @param item A BootstrapClientMenuItem object specifying the menu item to select.
+ */
+ SetSelectedItem(item: BootstrapClientMenuItem): void;
+ /**
+ * Returns a root menu item.
+ */
+ GetRootItem(): BootstrapClientMenuItem;
+ /**
+ * Sets the CSS selector of a web control or HTML element with which the current popup menu is associated.
+ * @param selector A string value specifying the CSS selector of the web control or HTML element with which the popup menu is associated.
*/
SetPopupElementCssSelector(selector: string): void;
+ /**
+ * Selects the specified menu item within a menu control on the client side.
+ * @param item An ASPxClientMenuItem object specifying the menu item to select.
+ */
+ SetSelectedItem(item: ASPxClientMenuItem): void;
}
/**
* Represents a client-side equivalent of the BootstrapProgressBar control.
@@ -19791,15 +21289,472 @@ interface BootstrapClientProgressBar extends ASPxClientProgressBar {
*/
interface BootstrapClientSpinEdit extends ASPxClientSpinEdit {
}
+/**
+ * Represents the client-side equivalent of the BootstrapClientTimeEdit control.
+ */
+interface BootstrapClientTimeEdit extends ASPxClientTimeEdit {
+}
/**
* Represents a client-side equivalent of the BootstrapTabControl control.
*/
interface BootstrapClientTabControl extends ASPxClientTabControl {
+ /**
+ * Returns the active tab within the Tab Control.
+ */
+ GetActiveTab(): BootstrapClientTab;
+ /**
+ * Makes the specified tab active within the Tab Control on the client side.
+ * @param tab A BootstrapClientTab object specifying the tab to select.
+ */
+ SetActiveTab(tab: BootstrapClientTab): void;
+ /**
+ * Returns a tab specified by its index.
+ * @param index An integer value specifying the zero-based index of the tab object to retrieve.
+ */
+ GetTab(index: number): BootstrapClientTab;
+ /**
+ * Returns a tab specified by its name.
+ * @param name A string value specifying the name of the tab.
+ */
+ GetTabByName(name: string): BootstrapClientTab;
+ /**
+ * Makes the specified tab active within the tab control on the client side.
+ * @param tab An ASPxClientTab object specifying the tab to select.
+ */
+ SetActiveTab(tab: ASPxClientTab): void;
}
/**
* Represents a client-side equivalent of the BootstrapPageControl control.
*/
interface BootstrapClientPageControl extends ASPxClientPageControl {
+ /**
+ * Returns the active tab within the Page Control.
+ */
+ GetActiveTab(): BootstrapClientTab;
+ /**
+ * Makes the specified tab active within the Page Control on the client side.
+ * @param tab A BootstrapClientTab object specifying the tab to select.
+ */
+ SetActiveTab(tab: BootstrapClientTab): void;
+ /**
+ * Returns a tab specified by its index.
+ * @param index An integer value specifying the zero-based index of the tab object to retrieve.
+ */
+ GetTab(index: number): BootstrapClientTab;
+ /**
+ * Returns a tab specified by its name.
+ * @param name A string value specifying the name of the tab.
+ */
+ GetTabByName(name: string): BootstrapClientTab;
+ /**
+ * Returns the HTML code that represents the contents of the specified page within the page control.
+ * @param tab An BootstrapClientTab object that specifies the required page.
+ */
+ GetTabContentHTML(tab: BootstrapClientTab): string;
+ /**
+ * Defines the HTML content for a specific tab page within the page control.
+ * @param tab A BootstrapClientTab object that specifies the required tab page.
+ * @param html A string value that represents the HTML code defining the content of the specified page.
+ */
+ SetTabContentHTML(tab: BootstrapClientTab, html: string): void;
+ /**
+ * Returns the HTML code that represents the contents of the specified page within the page control.
+ * @param tab An ASPxClientTab object that specifies the required page.
+ */
+ GetTabContentHTML(tab: ASPxClientTab): string;
+ /**
+ * Defines the HTML content for a specific tab page within the page control.
+ * @param tab An ASPxClientTab object that specifies the required tab page.
+ * @param html A string value that represents the HTML code defining the content of the specified page.
+ */
+ SetTabContentHTML(tab: ASPxClientTab, html: string): void;
+ /**
+ * Makes the specified tab active within the tab control on the client side.
+ * @param tab An ASPxClientTab object specifying the tab to select.
+ */
+ SetActiveTab(tab: ASPxClientTab): void;
+}
+/**
+ * Represents a client-side equivalent of a tab control's BootstrapTabPage object.
+ */
+interface BootstrapClientTab extends ASPxClientTab {
+ /**
+ * Gets the text displayed within the tab badge.
+ */
+ GetBadgeText(): string;
+ /**
+ * Sets the text displayed within the tab badge.
+ * @param text A String specifying the badge text.
+ */
+ SetBadgeText(text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within the tab badge.
+ */
+ GetBadgeIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed within the tab badge.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetBadgeIconCssClass(cssClass: string): void;
+ /**
+ * Returns the URL pointing to the image displayed within the tab.
+ */
+ GetImageUrl(): string;
+ /**
+ * Specifies the URL which points to the image displayed within the tab.
+ * @param value
+ */
+ SetImageUrl(value: string): void;
+ /**
+ * Returns the URL pointing to the image displayed within the active tab.
+ */
+ GetActiveImageUrl(): string;
+ /**
+ * Specifies the URL which points to the image displayed within the active tab.
+ * @param value
+ */
+ SetActiveImageUrl(value: string): void;
+ /**
+ * Gets the CSS class of the icon displayed by the tab.
+ */
+ GetIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed by the tab.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetIconCssClass(cssClass: string): void;
+ /**
+ * Gets the CSS class of an icon displayed by the tab when it is active.
+ */
+ GetActiveIconCssClass(): string;
+ /**
+ * Sets the CSS class of an icon displayed by the tab when it is active.
+ * @param cssClass A String containing the name of a CSS class.
+ */
+ SetActiveIconCssClass(cssClass: string): void;
+}
+/**
+ * A method that will handle a tab control's client events concerning manipulations with a tab.
+ */
+interface BootstrapClientTabControlTabEventHandler {
+ /**
+ * A method that will handle a tab control's client events concerning manipulations with a tab.
+ * @param source An object representing the event source. Identifies the BootstrapClientTabControl that raised the event.
+ * @param e An BootstrapClientTabControlTabEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientTabControlTabEventArgs): void;
+}
+/**
+ * Provides data for events related to manipulations on tabs.
+ */
+interface BootstrapClientTabControlTabEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the tab object related to the event.
+ * Value: A BootstrapClientTab object, manipulations on which forced the event to be raised.
+ */
+ tab: BootstrapClientTab;
+}
+/**
+ * A method that will handle a tab control's cancelable client events concerning manipulations with a tab.
+ */
+interface BootstrapClientTabControlTabCancelEventHandler {
+ /**
+ * A method that will handle a tab control's cancelable client events concerning manipulations with a tab.
+ * @param source An object representing the event source. Identifies the BootstrapTabControl that raised the event.
+ * @param e An BootstrapClientTabControlTabCancelEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientTabControlTabCancelEventArgs): void;
+}
+/**
+ * Provides data for cancellable events related to manipulations on tabs.
+ */
+interface BootstrapClientTabControlTabCancelEventArgs extends ASPxClientProcessingModeCancelEventArgs {
+ /**
+ * Gets the tab object related to the event.
+ * Value: A BootstrapClientTab object representing the tab manipulations on which forced the tab control to raise the event.
+ */
+ tab: BootstrapClientTab;
+ /**
+ * Gets or sets a value specifying whether a callback should be sent to the server to reload the content of the page being activated.
+ * Value: true, to reload the page's content; otherwise, false.
+ */
+ reloadContentOnCallback: boolean;
+}
+/**
+ * A method that will handle client events concerning clicks on tabs.
+ */
+interface BootstrapClientTabControlTabClickEventHandler {
+ /**
+ * A method that will handle client events concerning clicks on tabs.
+ * @param source An object representing the event source. Identifies the BootstrapTabControl that raised the event.
+ * @param e An BootstrapClientTabControlTabClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientTabControlTabClickEventArgs): void;
+}
+/**
+ * Provides data for events related to clicking on the control's tabs.
+ */
+interface BootstrapClientTabControlTabClickEventArgs extends BootstrapClientTabControlTabCancelEventArgs {
+ /**
+ * Gets an HTML object that contains the processed tab.
+ * Value: An HTML object.
+ */
+ htmlElement: Object;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: A DHTML event object.
+ */
+ htmlEvent: Object;
+}
+/**
+ * A client-side equivalent of the BootstrapTagBox object.
+ */
+interface BootstrapClientTagBox extends ASPxClientTokenBox {
+ /**
+ * Use the TagsChanged event instead.
+ */
+ TokensChanged: ASPxClientEvent>;
+ /**
+ * Fires on the client side after the tag collection has been changed.
+ */
+ TagsChanged: ASPxClientEvent>;
+ /**
+ * Adds a new token with the specified text to the end of the control's token collection.
+ * @param text
+ */
+ AddToken(text: string): void;
+ /**
+ * Adds a new tag with the specified text to the end of the control's tag collection.
+ * @param text A string value specifying the tag's text.
+ */
+ AddTag(text: string): void;
+ /**
+ * Use the RemoveTagByText method instead.
+ * @param text
+ */
+ RemoveTokenByText(text: string): void;
+ /**
+ * Removes a tag specified by its text from the tag box on the client.
+ * @param text A string value that is the text of the tag to be removed.
+ */
+ RemoveTagByText(text: string): void;
+ /**
+ * Use the RemoveTag method instead.
+ * @param index
+ */
+ RemoveToken(index: number): void;
+ /**
+ * Removes a tag specified by its index from the tag box on the client.
+ * @param index An integer value that is the index of the tag to be removed.
+ */
+ RemoveTag(index: number): void;
+ /**
+ * Returns an HTML span element that corresponds to the specified token.
+ * @param index
+ */
+ GetTokenHtmlElement(index: number): Object;
+ /**
+ * Returns an HTML span element that corresponds to the specified tag.
+ * @param index An integer value that is the tag index.
+ */
+ GetTagHtmlElement(index: number): Object;
+ /**
+ * Returns an HTML span element that corresponds to the specified token's text.
+ * @param index
+ */
+ GetTokenTextHtmlElement(index: number): Object;
+ /**
+ * Returns an HTML span element that corresponds to the specified tag's text.
+ * @param index An integer value that is the tag index.
+ */
+ GetTagTextHtmlElement(index: number): Object;
+ /**
+ * Returns an HTML span element that corresponds to the specified token's remove button.
+ * @param index
+ */
+ GetTokenRemoveButtonHtmlElement(index: number): Object;
+ /**
+ * Returns an HTML span element that corresponds to the specified tag's remove button.
+ * @param index An integer value that is the tag index.
+ */
+ GetTagRemoveButtonHtmlElement(index: number): Object;
+ /**
+ * Returns a collection of tokens.
+ */
+ GetTokenCollection(): string[];
+ /**
+ * Returns a collection of tags.
+ */
+ GetTagCollection(): string[];
+ /**
+ * Returns a collection of tokens.
+ * @param collection
+ */
+ SetTokenCollection(collection: string[]): void;
+ /**
+ * Sets a collection of tags.
+ * @param collection An object that is the collection of tags.
+ */
+ SetTagCollection(collection: string[]): void;
+ /**
+ * Use the ClearTagCollection method instead.
+ */
+ ClearTokenCollection(): void;
+ /**
+ * Removes all tags contained in the tag box.
+ */
+ ClearTagCollection(): void;
+ /**
+ * Returns the index of a token specified by its text.
+ * @param text
+ */
+ GetTokenIndexByText(text: string): number;
+ /**
+ * Returns the index of a tag specified by its text.
+ * @param text A string value that specifies the text of the tag.
+ */
+ GetTagIndexByText(text: string): number;
+ /**
+ * Use the IsCustomTag method instead.
+ * @param text
+ * @param caseSensitive
+ */
+ IsCustomToken(text: string, caseSensitive: boolean): boolean;
+ /**
+ * Returns a value that indicates if the specified tag (string) is a custom tag.
+ * @param text A string value that is a tag.
+ * @param caseSensitive true, if tags are case sensitive; otherwise, false.
+ */
+ IsCustomTag(text: string, caseSensitive: boolean): boolean;
+ /**
+ * Returns the editor's selected item.
+ */
+ GetSelectedItem(): BootstrapClientListBoxItem;
+ /**
+ * Sets the list editor's selected item.
+ * @param item A BootstrapClientListBoxItem object that specifies the item to select.
+ */
+ SetSelectedItem(item: BootstrapClientListBoxItem): void;
+ /**
+ * Returns an item specified by its index within the tag box editor's item collection.
+ * @param index An integer value specifying the zero-based index of the item to search for.
+ */
+ GetItem(index: number): BootstrapClientListBoxItem;
+ /**
+ * Returns an item by its text.
+ * @param text A string that specifies the item's text.
+ */
+ FindItemByText(text: string): BootstrapClientListBoxItem;
+ /**
+ * Returns a list item by its value.
+ * @param value An object that specifies the item's value.
+ */
+ FindItemByValue(value: Object): BootstrapClientListBoxItem;
+ /**
+ * This method is not in effect for the BootstrapClientTagBox class.
+ * @param texts
+ */
+ AddItem(texts: string[]): number;
+ /**
+ * This method is not in effect for the BootstrapClientTagBox class.
+ * @param texts
+ * @param value
+ */
+ AddItem(texts: string[], value: Object): number;
+ /**
+ * This method is not in effect for the BootstrapClientTagBox class.
+ * @param texts
+ * @param value
+ * @param iconCssClass
+ */
+ AddItem(texts: string[], value: Object, iconCssClass: string): number;
+ /**
+ * Adds a new item to the editor, specifying the item's display text, and returns the index of the added item.
+ * @param text A string value specifying the item's display text.
+ */
+ AddItem(text: string): number;
+ /**
+ * Adds a new item to the editor, specifying the item's display text and associated value, and returns the index of the added item.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
+ */
+ AddItem(text: string, value: Object): number;
+ /**
+ * Adds a new item to the editor, specifying the item's display text, associated value and displayed image, and returns the index of the added item.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
+ */
+ AddItem(text: string, value: Object, iconCssClass: string): number;
+ /**
+ * This method is not in effect for the BootstrapClientTagBox class.
+ * @param index
+ * @param texts
+ * @param value
+ * @param iconCssClass
+ */
+ InsertItem(index: number, texts: string[], value: Object, iconCssClass: string): void;
+ /**
+ * This method is not in effect for the BootstrapClientTagBox class.
+ * @param index
+ * @param texts
+ * @param value
+ */
+ InsertItem(index: number, texts: string[], value: Object): void;
+ /**
+ * This method is not in effect for the BootstrapClientTagBox class.
+ * @param index
+ * @param texts
+ */
+ InsertItem(index: number, texts: string[]): void;
+ /**
+ * Inserts a new item specified by its display text, associated value and displayed image into the editor's item collection, at the position specified.
+ * @param index An integer value that represents the index position.
+ * @param text A string value specifying the item's display text.
+ * @param value An object specifying the value associated with the item.
+ * @param iconCssClass A String value specifying the CSS class of the image displayed by the list item.
+ */
+ InsertItem(index: number, text: string, value: Object, iconCssClass: string): void;
+ /**
+ * Inserts a new item specified by its display text, associated value and displayed image into the editor's item collection, at the position specified.
+ * @param index An integer value that represents the index position.
+ * @param text A string value specifying the item's display text.
+ * @param value An object that represents the item's associated value.
+ */
+ InsertItem(index: number, text: string, value: Object): void;
+ /**
+ * Inserts a new item into the control's items collection at the specified index.
+ * @param index An integer value that represents the index position.
+ * @param text A string value specifying the item's display text.
+ */
+ InsertItem(index: number, text: string): void;
+ /**
+ * Gets the text displayed within a Tag Box item badge.
+ * @param index The index of a Tag Box item.
+ */
+ GetItemBadgeText(index: number): string;
+ /**
+ * Sets the text displayed within a Tag Box item badge.
+ * @param index The index of a Tag Box item.
+ * @param text A String specifying the badge text.
+ */
+ SetItemBadgeText(index: number, text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within a Tag Box item badge.
+ * @param index The index of a Tag Box item.
+ */
+ GetItemBadgeIconCssClass(index: number): string;
+ /**
+ * Sets the CSS class of the icon displayed within a Tag Box item badge.
+ * @param index The index of a Tag Box item.
+ * @param cssClass A String containing the name of a CSS class.
+ */
+ SetItemBadgeIconCssClass(index: number, cssClass: string): void;
+ /**
+ * Sets the list editor's selected item.
+ * @param item An ASPxClientListEditItem object that specifies the item to select.
+ */
+ SetSelectedItem(item: ASPxClientListEditItem): void;
}
/**
* Represents a client-side equivalent of the BootstrapTextBox control.
@@ -19816,79 +21771,741 @@ interface BootstrapClientMemo extends ASPxClientMemo {
*/
interface BootstrapClientButtonEdit extends ASPxClientButtonEdit {
}
+/**
+ * Represents the client-side equivalent of the BootstrapToolbar control.
+ */
+interface BootstrapClientToolbar extends BootstrapClientMenu {
+}
/**
* Represents a client-side equivalent of the BootstrapTreeView control.
*/
interface BootstrapClientTreeView extends ASPxClientTreeView {
+ /**
+ * Returns a node specified by its index within the Tree View's node collection.
+ * @param index An integer value specifying the zero-based index of the node to be retrieved.
+ */
+ GetNode(index: number): BootstrapClientTreeViewNode;
+ /**
+ * Returns a node specified by its name.
+ * @param name A string value specifying the name of the node.
+ */
+ GetNodeByName(name: string): BootstrapClientTreeViewNode;
+ /**
+ * Returns a node specified by its text.
+ * @param text A string value specifying the text content of the node.
+ */
+ GetNodeByText(text: string): BootstrapClientTreeViewNode;
+ /**
+ * Returns the selected node within the Tree View control on the client side.
+ */
+ GetSelectedNode(): BootstrapClientTreeViewNode;
+ /**
+ * Selects the specified node within the Tree View control on the client side.
+ * @param node A BootstrapClientTreeViewNode object specifying the node to select.
+ */
+ SetSelectedNode(node: BootstrapClientTreeViewNode): void;
+ /**
+ * Gets the root node of the Tree View control.
+ */
+ GetRootNode(): BootstrapClientTreeViewNode;
+ /**
+ * Selects the specified node within the ASPxTreeView control on the client side.
+ * @param node An ASPxClientTreeViewNode object specifying the node to select.
+ */
+ SetSelectedNode(node: ASPxClientTreeViewNode): void;
}
-interface BootstrapUIWidgetBase extends ASPxClientControl {
- Init: ASPxClientEvent>;
- Drawn: ASPxClientEvent>;
- Disposing: ASPxClientEvent>;
- OptionChanged: ASPxClientEvent>;
- Exporting: ASPxClientEvent>;
- Exported: ASPxClientEvent>;
- FileSaving: ASPxClientEvent>;
- IncidentOccurred: ASPxClientEvent>;
- GetInstance(): Object;
- SetOptions(options: Object): void;
- SetDataSource(dataSource: Object): void;
- GetDataSource(): Object;
- ExportTo(format: string, fileName: string): void;
- Print(): void;
+/**
+ * Represents a client-side equivalent of the TreeView's BootstrapTreeViewNode object.
+ */
+interface BootstrapClientTreeViewNode extends ASPxClientTreeViewNode {
+ /**
+ * Gets the BootstrapClientTreeView object to which the current node belongs.
+ * Value: A object that is the node's owner.
+ */
+ treeView: BootstrapClientTreeView;
+ /**
+ * Gets the current node's parent node.
+ * Value: A BootstrapClientTreeViewNode object representing the node's immediate parent.
+ */
+ parent: BootstrapClientTreeViewNode;
+ /**
+ * Returns the current node's immediate child node specified by its index.
+ * @param index An integer value specifying the zero-based index of the node to be retrieved.
+ */
+ GetNode(index: number): BootstrapClientTreeViewNode;
+ /**
+ * Returns the current node's child node specified by its name.
+ * @param name A string value specifying the name of the node.
+ */
+ GetNodeByName(name: string): BootstrapClientTreeViewNode;
+ /**
+ * Returns the current node's child node specified by its text.
+ * @param text A string value specifying the text content of the node.
+ */
+ GetNodeByText(text: string): BootstrapClientTreeViewNode;
+ /**
+ * Gets the text displayed within the node badge.
+ */
+ GetBadgeText(): string;
+ /**
+ * Sets the text displayed within the node badge.
+ * @param text A String specifying the badge text.
+ */
+ SetBadgeText(text: string): void;
+ /**
+ * Gets the CSS class of the icon displayed within the node badge.
+ */
+ GetBadgeIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed within the node badge.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetBadgeIconCssClass(cssClass: string): void;
+ /**
+ * Returns the URL pointing to the image displayed within the node.
+ */
+ GetImageUrl(): string;
+ /**
+ * Sets the URL which points to the image displayed within the node.
+ * @param value
+ */
+ SetImageUrl(value: string): void;
+ /**
+ * Gets the CSS class of the icon displayed by the node.
+ */
+ GetIconCssClass(): string;
+ /**
+ * Sets the CSS class of the icon displayed by the node.
+ * @param cssClass A string containing the name of a CSS class.
+ */
+ SetIconCssClass(cssClass: string): void;
}
-interface BootstrapUIWidgetInitializedEventHandler {
- (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+/**
+ * A method that will handle the client events concerned with node processing.
+ */
+interface BootstrapClientTreeViewNodeProcessingModeEventHandler {
+ /**
+ * A method that will handle the client events concerned with node processing.
+ * @param source An object representing the event source. Identifies the BootstrapClientTreeView control that raised the event.
+ * @param e An BootstrapClientTreeViewNodeProcessingModeEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientTreeViewNodeProcessingModeEventArgs): void;
}
-interface BootstrapUIWidgetDrawnEventHandler {
- (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+/**
+ * Provides data for the client events related to node processing, and allowing the event's processing to be passed to the server side.
+ */
+interface BootstrapClientTreeViewNodeProcessingModeEventArgs extends ASPxClientProcessingModeEventArgs {
+ /**
+ * Gets a node object related to the event.
+ * Value: A BootstrapClientTreeViewNode object, manipulations on which forced the event to be raised.
+ */
+ node: BootstrapClientTreeViewNode;
}
-interface BootstrapUIWidgetDisposingEventHandler {
- (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+/**
+ * A method that will handle the NodeClick event.
+ */
+interface BootstrapClientTreeViewNodeClickEventHandler {
+ /**
+ * A method that will handle the NodeClick event.
+ * @param source An object representing the event source. Identifies the BootstrapClientTreeView control that raised the event.
+ * @param e An BootstrapClientTreeViewNodeClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientTreeViewNodeClickEventArgs): void;
}
-interface BootstrapUIWidgetExportedEventHandler {
- (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+/**
+ * Provides data for the NodeClick event.
+ */
+interface BootstrapClientTreeViewNodeClickEventArgs extends BootstrapClientTreeViewNodeProcessingModeEventArgs {
+ /**
+ * Gets an HTML object that contains the processed Tree View node.
+ * Value: An HTML object.
+ */
+ htmlElement: Object;
+ /**
+ * Gets a DHTML event object that relates to the processed event.
+ * Value: A DHTML event object.
+ */
+ htmlEvent: Object;
}
-interface BootstrapUIWidgetOptionChangedEventHandler {
- (source: S, e: BootstrapUIWidgetOptionChangedEventArgs): void;
+/**
+ * A method that will handle the Tree View control's client events, concerning manipulations with a node.
+ */
+interface BootstrapClientTreeViewNodeEventHandler {
+ /**
+ * A method that will handle the Tree View control's client events, concerning manipulations with a node.
+ * @param source An object representing the event source. Identifies the BootstrapClientTreeView control that raised the event.
+ * @param e An BootstrapClientTreeViewNodeEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientTreeViewNodeEventArgs): void;
}
-interface BootstrapUIWidgetOptionChangedEventArgs extends BootstrapUIWidgetEventArgsBase {
- fullName: string;
- name: string;
- previousValue: Object;
- value: Object;
+/**
+ * Provides data for the ExpandedChanged events.
+ */
+interface BootstrapClientTreeViewNodeEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets a node object related to the event.
+ * Value: A BootstrapClientTreeViewNode object, manipulations on which forced the event to be raised.
+ */
+ node: BootstrapClientTreeViewNode;
}
-interface BootstrapUIWidgetExportingEventHandler {
- (source: S, e: BootstrapUIWidgetExportEventArgs): void;
+/**
+ * A method that will handle the Tree View's cancelable client events, concerning manipulations with nodes.
+ */
+interface BootstrapClientTreeViewNodeCancelEventHandler {
+ /**
+ * A method that will handle the Tree View's cancelable client events, concerning manipulations with nodes.
+ * @param source An object representing the event source. Identifies the BootstrapClientTreeView control that raised the event.
+ * @param e An BootstrapClientTreeViewNodeCancelEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientTreeViewNodeCancelEventArgs): void;
}
-interface BootstrapUIWidgetFileSavingEventHandler {
- (source: S, e: BootstrapUIWidgetExportEventArgs): void;
-}
-interface BootstrapUIWidgetExportEventArgs extends BootstrapUIWidgetEventArgsBase {
- cancel: boolean;
- data: Object;
- fileName: string;
- format: string;
-}
-interface BootstrapUIWidgetErrorEventHandler {
- (source: S, e: BootstrapUIWidgetErrorEventArgs): void;
-}
-interface BootstrapUIWidgetErrorEventArgs extends BootstrapUIWidgetEventArgsBase {
- target: Object;
-}
-interface BootstrapUIWidgetElementActionEventArgs extends BootstrapUIWidgetEventArgsBase {
- target: Object;
-}
-interface BootstrapUIWidgetElementClickEventArgs extends BootstrapUIWidgetElementActionEventArgs {
- jQueryEvent: Object;
+/**
+ * Provides data for the ExpandedChanging event.
+ */
+interface BootstrapClientTreeViewNodeCancelEventArgs extends ASPxClientProcessingModeCancelEventArgs {
+ /**
+ * Gets a node object related to the event.
+ * Value: A BootstrapClientTreeViewNode object, manipulations on which forced the event to be raised.
+ */
+ node: BootstrapClientTreeViewNode;
}
/**
* Represents a client-side equivalent of the BootstrapUploadControl.
*/
interface BootstrapClientUploadControl extends ASPxClientUploadControl {
}
+/**
+ * Represents the client BootstrapGridView.
+ */
interface BootstrapClientGridView extends ASPxClientGridView {
}
+/**
+ * Represents the client BootstrapCardView.
+ */
+interface BootstrapClientCardView extends ASPxClientGridView {
+}
+/**
+ * Represents a client-side equivalent of the BootstrapWebClientUIWidget class.
+ */
+interface BootstrapUIWidgetBase extends ASPxClientControl {
+ /**
+ * Fires once, after the widget is initialized.
+ */
+ Init: ASPxClientEvent>;
+ /**
+ * Fires when the widget has finished drawing itself.
+ */
+ Drawn: ASPxClientEvent>;
+ /**
+ * Fires when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.
+ */
+ Disposing: ASPxClientEvent>;
+ /**
+ * Fires after an option of the widget has been changed.
+ */
+ OptionChanged: ASPxClientEvent>;
+ /**
+ * Fires before data from the widget is exported.
+ */
+ Exporting: ASPxClientEvent>;
+ /**
+ * Fires after data from the widget is exported.
+ */
+ Exported: ASPxClientEvent>;
+ /**
+ * Raised before a file with exported data is saved on the user's local storage.
+ */
+ FileSaving: ASPxClientEvent>;
+ /**
+ * Fires when an error or warning appears in the widget.
+ */
+ IncidentOccurred: ASPxClientEvent>;
+ /**
+ * Gets an instance of the widget.
+ */
+ GetInstance(): Object;
+ /**
+ * Sets the widget's options to values specified in the passed object.
+ * @param options An object containing key-value pairs specifying new option values.
+ */
+ SetOptions(options: Object): void;
+ /**
+ * Gets the client data source instance.
+ * @param dataSource A DevExtreme DataSource object.
+ */
+ SetDataSource(dataSource: Object): void;
+ /**
+ * Gets the client data source instance.
+ */
+ GetDataSource(): Object;
+ /**
+ * Exports the widget.
+ * @param format A string specifying the target file format.
+ * @param fileName A string specifying the file name.
+ */
+ ExportTo(format: string, fileName: string): void;
+ /**
+ * Invokes the browser's Print window to print the widget's contents.
+ */
+ Print(): void;
+}
+/**
+ * Represents a client-side equivalent of the BootstrapChartBase class.
+ */
+interface BootstrapClientChartBase extends BootstrapUIWidgetBase {
+ /**
+ * Fires when the Series and Points chart elements are ready to be accessed.
+ */
+ Done: ASPxClientEvent>;
+ /**
+ * Fires when an item on the chart legend is clicked.
+ */
+ LegendClick: ASPxClientEvent>;
+ /**
+ * Fires when a user clicks a series point.
+ */
+ PointClick: ASPxClientEvent>;
+ /**
+ * Fires when the hover state of a series point has been changed.
+ */
+ PointHoverChanged: ASPxClientEvent>;
+ /**
+ * Fires when the selection state of a series point has been changed.
+ */
+ PointSelectionChanged: ASPxClientEvent>;
+ /**
+ * Fires when a point's tooltip becomes hidden.
+ */
+ TooltipHidden: ASPxClientEvent>;
+ /**
+ * Fires when a point's tooltip appears.
+ */
+ TooltipShown: ASPxClientEvent>;
+ /**
+ * Fires when a user clicks a label on the argument axis.
+ */
+ ArgumentAxisClick: ASPxClientEvent>;
+ /**
+ * Fires when a user clicks a series.
+ */
+ SeriesClick: ASPxClientEvent>;
+ /**
+ * Fires when the hover state of a series has been changed.
+ */
+ SeriesHoverChanged: ASPxClientEvent>;
+ /**
+ * Fires when the selection state of a series has been changed.
+ */
+ SeriesSelectionChanged: ASPxClientEvent>;
+}
+/**
+ * Represents a client-side equivalent of the Chart control.
+ */
+interface BootstrapClientChart extends BootstrapClientChartBase {
+ /**
+ * Fires when a chart zooming or scrolling begins.
+ */
+ ZoomStart: ASPxClientEvent>;
+ /**
+ * Fires when a chart zooming or scrolling ends.
+ */
+ ZoomEnd: ASPxClientEvent>;
+}
+/**
+ * Represents a client-side equivalent of the BootstrapPolarChart control.
+ */
+interface BootstrapClientPolarChart extends BootstrapClientChartBase {
+}
+/**
+ * Represents a client-side equivalent of the BootstrapPieChart control.
+ */
+interface BootstrapClientPieChart extends BootstrapClientChartBase {
+}
+/**
+ * A method that will handle the Done event.
+ */
+interface BootstrapClientChartBaseDoneEventHandler {
+ /**
+ * A method that will handle the Done event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetEventArgsBase object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+}
+/**
+ * A method that will handle the LegendClick event.
+ */
+interface BootstrapClientChartBaseLegendClickEventHandler {
+ /**
+ * A method that will handle the LegendClick event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
+}
+/**
+ * A method that will handle the Invoke event.
+ */
+interface BootstrapClientCoordinateSystemChartArgumentAxisClickEventHandler {
+ /**
+ * A method that will handle the Invoke event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
+}
+/**
+ * A method that will handle the PointClick event.
+ */
+interface BootstrapClientChartBasePointClickEventHandler {
+ /**
+ * A method that will handle the PointClick event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
+}
+/**
+ * A method that will handle the PointHoverChanged event.
+ */
+interface BootstrapClientChartBasePointHoverChangedEventHandler {
+ /**
+ * A method that will handle the PointHoverChanged event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementActionEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
+}
+/**
+ * A method that will handle the PointSelectionChanged event.
+ */
+interface BootstrapClientChartBasePointSelectionChangedEventHandler {
+ /**
+ * A method that will handle the PointSelectionChanged event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementActionEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
+}
+/**
+ * A method that will handle the TooltipHidden event.
+ */
+interface BootstrapClientChartBaseTooltipHiddenEventHandler {
+ /**
+ * A method that will handle the TooltipHidden event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementActionEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
+}
+/**
+ * A method that will handle the TooltipShown event.
+ */
+interface BootstrapClientChartBaseTooltipShownEventHandler {
+ /**
+ * A method that will handle the TooltipShown event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementActionEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
+}
+/**
+ * A method that will handle the SeriesClick event.
+ */
+interface BootstrapClientCoordinateSystemChartSeriesClickEventHandler {
+ /**
+ * A method that will handle the SeriesClick event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementClickEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementClickEventArgs): void;
+}
+/**
+ * A method that will handle the SeriesHoverChanged event.
+ */
+interface BootstrapClientCoordinateSystemChartSeriesHoverChangedEventHandler {
+ /**
+ * A method that will handle the SeriesHoverChanged event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementActionEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
+}
+/**
+ * A method that will handle the SeriesSelectionChanged event.
+ */
+interface BootstrapClientCoordinateSystemChartSeriesSelectionChangedEventHandler {
+ /**
+ * A method that will handle the SeriesSelectionChanged event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetElementActionEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetElementActionEventArgs): void;
+}
+/**
+ * A method that will handle the ZoomStart event.
+ */
+interface BootstrapClientChartZoomStartEventHandler {
+ /**
+ * A method that will handle the ZoomStart event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetEventArgsBase object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+}
+/**
+ * A method that will handle the ZoomEnd event.
+ */
+interface BootstrapClientChartZoomEndEventHandler {
+ /**
+ * A method that will handle the ZoomEnd event.
+ * @param source The event source.
+ * @param e A BootstrapClientChartZoomEndEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientChartZoomEndEventArgs): void;
+}
+/**
+ * Provides base data for the client-side events.
+ */
+interface BootstrapUIWidgetEventArgsBase extends ASPxClientEventArgs {
+ /**
+ * The widget instance.
+ * Value: An object specifying the widget instance.
+ */
+ component: Object;
+ /**
+ * The widget's container.
+ * Value: An object specifying the widget's container.
+ */
+ element: Object;
+}
+/**
+ * Provides data for the ZoomEnd event.
+ */
+interface BootstrapClientChartZoomEndEventArgs extends BootstrapUIWidgetEventArgsBase {
+ /**
+ * The value that became the start of the argument axis after zooming or scrolling ended.
+ * Value: An object specifying the start of the argument axis.
+ */
+ rangeStart: Object;
+ /**
+ * The value that became the end of the argument axis after zooming or scrolling ended.
+ * Value: An object specifying the end of the argument axis.
+ */
+ rangeEnd: Object;
+}
+/**
+ * Represents a client-side equivalent of the Range Selector control.
+ */
+interface BootstrapClientRangeSelector extends BootstrapUIWidgetBase {
+ /**
+ * Fires after the selected range has been changed by moving one of the sliders.
+ */
+ ValueChanged: ASPxClientEvent>;
+ /**
+ * Gets the Range Selector's selected value range.
+ */
+ GetValue(): Object[];
+ /**
+ * Gets the Range Selector's selected value range.
+ * @param value An array containing the value range.
+ */
+ SetValue(value: Object[]): void;
+}
+/**
+ * Provides data for events which concern manipulations on the selected range.
+ */
+interface BootstrapClientRangeSelectorValueChangedEventArgs extends BootstrapUIWidgetEventArgsBase {
+ /**
+ * The value currently specified for the RangeSelector control.
+ * Value: A System.Object instance defining the current value specified for a RangeSelector control.
+ */
+ value: Object;
+ /**
+ * The previous value of a RangeSelector control.
+ * Value: A System.Object type defining the previous value specified for a RangeSelector control.
+ */
+ previousValue: Object;
+}
+/**
+ * A method that will handle the ValueChanged event.
+ */
+interface BootstrapClientRangeSelectorValueChangedEventHandler {
+ /**
+ * A method that will handle the ValueChanged event.
+ * @param source The event source.
+ * @param e A BootstrapClientRangeSelectorValueChangedEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapClientRangeSelectorValueChangedEventArgs): void;
+}
+/**
+ * A method that will handle the Init event.
+ */
+interface BootstrapUIWidgetInitializedEventHandler {
+ /**
+ * A method that will handle the Init event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetEventArgsBase object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+}
+/**
+ * A method that will handle the Drawn event.
+ */
+interface BootstrapUIWidgetDrawnEventHandler {
+ /**
+ * A method that will handle the Drawn event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetEventArgsBase object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+}
+/**
+ * A method that will handle the Disposing event.
+ */
+interface BootstrapUIWidgetDisposingEventHandler {
+ /**
+ * A method that will handle the Disposing event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetEventArgsBase object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+}
+/**
+ * A method that will handle the Exported event.
+ */
+interface BootstrapUIWidgetExportedEventHandler {
+ /**
+ * A method that will handle the Exported event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetEventArgsBase object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetEventArgsBase): void;
+}
+/**
+ * A method that will handle the OptionChanged event.
+ */
+interface BootstrapUIWidgetOptionChangedEventHandler {
+ /**
+ * A method that will handle the OptionChanged event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetOptionChangedEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetOptionChangedEventArgs): void;
+}
+/**
+ * Provides data for client events raised in response to changing the widget's options.
+ */
+interface BootstrapUIWidgetOptionChangedEventArgs extends BootstrapUIWidgetEventArgsBase {
+ /**
+ * The option's full name.
+ * Value: A string value specifying the option's full name.
+ */
+ fullName: string;
+ /**
+ * The option's short name.
+ * Value: A string value specifying the option's short name.
+ */
+ name: string;
+ /**
+ * The option's old value.
+ * Value: An object that is the option's old value.
+ */
+ previousValue: Object;
+ /**
+ * The option's new value.
+ * Value: An object that is the option's new value.
+ */
+ value: Object;
+}
+/**
+ * A method that will handle the Exporting event.
+ */
+interface BootstrapUIWidgetExportingEventHandler {
+ /**
+ * A method that will handle the Exporting event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetExportEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetExportEventArgs): void;
+}
+/**
+ * A method that will handle the FileSaving event.
+ */
+interface BootstrapUIWidgetFileSavingEventHandler {
+ /**
+ * A method that will handle the FileSaving event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetExportEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetExportEventArgs): void;
+}
+/**
+ * Provides data for events related to saving files in the built-in dialogs.
+ */
+interface BootstrapUIWidgetExportEventArgs extends BootstrapUIWidgetEventArgsBase {
+ /**
+ * Allows you to cancel file saving.
+ * Value: true, to cancel the file saving; otherwise, false.
+ */
+ cancel: boolean;
+ /**
+ * Gets the saved data as a BLOB object.
+ * Value: A BLOB object containing saved data.
+ */
+ data: Object;
+ /**
+ * Gets a name of a saved file.
+ * Value: A string value specifying the saved file's name.
+ */
+ fileName: string;
+ /**
+ * Gets the saved file's format.
+ * Value: A string value specifying the saved file's format.
+ */
+ format: string;
+}
+/**
+ * A method that will handle the IncidentOccurred event.
+ */
+interface BootstrapUIWidgetErrorEventHandler {
+ /**
+ * A method that will handle the IncidentOccurred event.
+ * @param source The event source.
+ * @param e A BootstrapUIWidgetErrorEventArgs object that contains event data.
+ */
+ (source: S, e: BootstrapUIWidgetErrorEventArgs): void;
+}
+/**
+ * Provides data for client events raised in response to widget errors.
+ */
+interface BootstrapUIWidgetErrorEventArgs extends BootstrapUIWidgetEventArgsBase {
+ /**
+ * Contains information on the error that occurred.
+ * Value: An object containing information on the error that occurred.
+ */
+ target: Object;
+}
+/**
+ * Provides data for client events related to actions performed on the widget's visual elements.
+ */
+interface BootstrapUIWidgetElementActionEventArgs extends BootstrapUIWidgetEventArgsBase {
+ /**
+ * The DOM element that initiated the event.
+ * Value: An object that initiated the event.
+ */
+ target: Object;
+}
+/**
+ * Provides data for the client-side clicking events.
+ */
+interface BootstrapUIWidgetElementClickEventArgs extends BootstrapUIWidgetElementActionEventArgs {
+ /**
+ * The jQuery event that caused the handler execution.
+ * Value: An object of the jQuery.Event type.
+ */
+ jQueryEvent: Object;
+}
/**
* A client-side counterpart of the Calendar and CalendarFor extensions.
*/
@@ -20343,7 +22960,7 @@ interface MVCxClientPopupControl extends ASPxClientPopupControl {
*/
PerformWindowCallback(window: ASPxClientPopupWindow, data: Object): void;
/**
- *
+ * Sends a callback with parameters to update the popup window by processing the related popup window.
* @param window
* @param parameter
*/
@@ -20849,6 +23466,27 @@ interface MVCxClientVerticalGrid extends ASPxClientVerticalGrid {
*/
interface MVCxClientWebDocumentViewer extends ASPxClientWebDocumentViewer {
}
+interface ANCxClientBeginCallbackEventHandler {
+ (source: S, e: ANCxClientBeginCallbackEventArgs): void;
+}
+/**
+ * Serves as the base class for arguments of the web controls' client-side events.
+ */
+interface ASPxClientEventArgs {
+}
+/**
+ * Provides data for client events related to the beginning of a callback processing round trip.
+ */
+interface ASPxClientBeginCallbackEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets a command name that identifies which client action forced a callback to be occurred.
+ * Value: A string value that represents the name of the command which initiated a callback.
+ */
+ command: string;
+}
+interface ANCxClientBeginCallbackEventArgs extends ASPxClientBeginCallbackEventArgs {
+ customArgs: Object;
+}
/**
* Serves as the base type for all the objects included in the client-side object model.
*/
@@ -20871,6 +23509,10 @@ interface ASPxClientControlBase {
* @param message A String value that specifies a text.
*/
SendMessageToAssistiveTechnology(message: string): void;
+ /**
+ * Returns a client instance of the control that is the parent for a specified control.
+ */
+ GetParentControl(): Object;
/**
* Returns a value specifying whether a control is displayed.
*/
@@ -20969,11 +23611,6 @@ interface ASPxClientCallbackCompleteEventHandler {
*/
(source: S, e: ASPxClientCallbackCompleteEventArgs): void;
}
-/**
- * Serves as the base class for arguments of the web controls' client-side events.
- */
-interface ASPxClientEventArgs {
-}
/**
* Provides data for events concerning the final processing of a callback.
*/
@@ -21195,11 +23832,6 @@ interface ASPxClientProcessingModeCancelEventArgs extends ASPxClientProcessingMo
*/
interface KnockoutObservableBoolean {
}
-/**
- * Provides access to observable arrays that allow you to detect and respond to changes in a collection of things.
- */
-interface KnockoutObservableArray {
-}
/**
* Represents a JavaScript function which receives callback data obtained via a call to a specific client method (such as the PerformDataCallback).
*/
@@ -21262,16 +23894,6 @@ interface ASPxClientBeginCallbackEventHandler {
*/
(source: S, e: ASPxClientBeginCallbackEventArgs): void;
}
-/**
- * Provides data for client events related to the beginning of a callback processing round trip.
- */
-interface ASPxClientBeginCallbackEventArgs extends ASPxClientEventArgs {
- /**
- * Gets a command name that identifies which client action forced a callback to be occurred.
- * Value: A string value that represents the name of the command which initiated a callback.
- */
- command: string;
-}
/**
* A method that will handle the BeginCallback event.
*/
@@ -22478,6 +25100,10 @@ interface ASPxClientFileManagerItem {
* @param skipRootFolder true, to skip the root folder; otherwise, false.
*/
GetFullName(separator: string, skipRootFolder: boolean): string;
+ /**
+ * Gets the current item's metadata.
+ */
+ GetMetadata(): Object;
}
/**
* Represents the client-side equivalent of the FileManagerFile object.
@@ -23523,6 +26149,11 @@ interface ASPxClientHintOptions {
* Value: true, to display a hint in a callout box; otherwise, false.
*/
showCallout: boolean;
+ /**
+ * Gets or sets a value that specifies whether a hint's title is displayed.
+ * Value: true, to display the hint's title; otherwise, false.
+ */
+ showTitle: boolean;
/**
* Gets or sets where a hint should be positioned.
* Value: A string value that specifies a hint position.
@@ -24596,7 +27227,7 @@ interface ASPxClientPopupControl extends ASPxClientPopupControlBase {
*/
GetWindowPopUpReasonMouseEvent(window: ASPxClientPopupWindow): Object;
/**
- *
+ * Sends a callback with parameters to update the popup window by processing the related popup window.
* @param window
* @param parameter
*/
@@ -24749,6 +27380,103 @@ interface ASPxClientPopupControl extends ASPxClientPopupControlBase {
* @param html A string value that represents the HTML code defining the content of the specified popup window.
*/
SetWindowContentHtml(window: ASPxClientPopupWindow, html: string): void;
+ /**
+ * Stretches the popup window in adaptive mode vertically to the full height of the browser window.
+ */
+ StretchVertically(): void;
+ /**
+ * Stretches the specified popup window in adaptive mode vertically to the full height of the browser window.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ */
+ WindowStretchVertically(window: ASPxClientPopupWindow): void;
+ /**
+ * Sets the minimum width of the popup window in adaptive mode.
+ * @param minWidth An integer value specifying the minimum width of the popup window in adaptive mode.
+ */
+ SetAdaptiveMinWidth(minWidth: number): void;
+ /**
+ * Sets the minimum width of the popup window in adaptive mode.
+ * @param minWidth A string value specifying the minimum width of the popup window in adaptive mode as a percentage of the browser window inner width value.
+ */
+ SetAdaptiveMinWidth(minWidth: string): void;
+ /**
+ * Sets the minimum width of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param minWidth An integer value specifying the minimum width of the popup window in adaptive mode.
+ */
+ SetWindowAdaptiveMinWidth(window: ASPxClientPopupWindow, minWidth: number): void;
+ /**
+ * Sets the minimum width of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param minWidth An integer value specifying the minimum width of the popup window in adaptive mode as a percentage of the browser window inner width value.
+ */
+ SetWindowAdaptiveMinWidth(window: ASPxClientPopupWindow, minWidth: string): void;
+ /**
+ * Sets the maximum width of the popup window in adaptive mode.
+ * @param maxWidth An integer value specifying the maximum width of the popup window in adaptive mode.
+ */
+ SetAdaptiveMaxWidth(maxWidth: number): void;
+ /**
+ * Sets the maximum width of the popup window in adaptive mode.
+ * @param maxWidth A string value specifying the maximum width of the popup window in adaptive mode as a percentage of the browser window inner width value.
+ */
+ SetAdaptiveMaxWidth(maxWidth: string): void;
+ /**
+ * Sets the maximum width of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param maxWidth An integer value specifying the maximum width of the popup window in adaptive mode.
+ */
+ SetWindowAdaptiveMaxWidth(window: ASPxClientPopupWindow, maxWidth: number): void;
+ /**
+ * Sets the maximum width of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param maxWidth An integer value specifying the maximum width of the popup window in adaptive mode as a percentage of the browser window inner width value.
+ */
+ SetWindowAdaptiveMaxWidth(window: ASPxClientPopupWindow, maxWidth: string): void;
+ /**
+ * Sets the minimum height of the popup window in adaptive mode.
+ * @param minHeight An integer value specifying the minimum height of the popup window in adaptive mode.
+ */
+ SetAdaptiveMinHeight(minHeight: number): void;
+ /**
+ * Sets the minimum height of the popup window in adaptive mode.
+ * @param minHeight A string value specifying the minimum height of the popup window in adaptive mode as a percentage of the browser window inner height value.
+ */
+ SetAdaptiveMinHeight(minHeight: string): void;
+ /**
+ * Sets the minimum height of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param minHeight An integer value specifying the minimum height of the popup window in adaptive mode.
+ */
+ SetWindowAdaptiveMinHeight(window: ASPxClientPopupWindow, minHeight: number): void;
+ /**
+ * Sets the minimum height of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param minHeight An integer value specifying the minimum height of the popup window in adaptive mode as a percentage of the browser window inner height value.
+ */
+ SetWindowAdaptiveMinHeight(window: ASPxClientPopupWindow, minHeight: string): void;
+ /**
+ * Sets the maximum height of the popup window in adaptive mode.
+ * @param maxHeight An integer value specifying the maximum height of the popup window in adaptive mode.
+ */
+ SetAdaptiveMaxHeight(maxHeight: number): void;
+ /**
+ * Sets the maximum height of the popup window in adaptive mode.
+ * @param maxHeight A string value specifying the maximum height of the popup window in adaptive mode as a percentage of the browser window inner height value.
+ */
+ SetAdaptiveMaxHeight(maxHeight: string): void;
+ /**
+ * Sets the maximum height of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param maxHeight An integer value specifying the maximum height of the popup window in adaptive mode.
+ */
+ SetWindowAdaptiveMaxHeight(window: ASPxClientPopupWindow, maxHeight: number): void;
+ /**
+ * Sets the maximum height of the specified popup window in adaptive mode.
+ * @param window A ASPxClientPopupWindow object representing the required popup window.
+ * @param maxHeight An integer value specifying the maximum height of the popup window in adaptive mode as a percentage of the browser window inner height value.
+ */
+ SetWindowAdaptiveMaxHeight(window: ASPxClientPopupWindow, maxHeight: string): void;
/**
* Returns an iframe object containing a web page specified via the specified popup window's SetWindowContentUrl client method).
* @param window A ASPxClientPopupWindow object representing the required popup window.
@@ -28890,7 +31618,7 @@ interface ASPxClientDocumentViewer extends ASPxClientControl {
*/
EndCallback: ASPxClientEvent>;
/**
- * Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientDocumentViewer.
+ * Fires on the client if any server error occurs during server-side processing of a callback sent by ASPxClientDocumentViewer.
*/
CallbackError: ASPxClientEvent>;
/**
@@ -29011,13 +31739,17 @@ interface ASPxClientQueryBuilder extends ASPxClientControl {
*/
EndCallback: ASPxClientEvent>;
/**
- * Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientQueryBuilder.
+ * Fires on the client if any server error occurs during server-side processing of a callback sent by ASPxClientQueryBuilder.
*/
CallbackError: ASPxClientEvent>;
/**
* Enables you to customize the menu actions of a Query Builder.
*/
CustomizeToolbarActions: ASPxClientEvent>;
+ /**
+ * Enables you to customize the Query Builder's localization strings.
+ */
+ CustomizeLocalization: ASPxClientEvent>;
/**
* Occurs when executing the Save command on the client.
*/
@@ -29034,7 +31766,7 @@ interface ASPxClientQueryBuilder extends ASPxClientControl {
*/
PerformCallback(arg: string, onSuccess: (arg1: string) => void): void;
/**
- * Updates the localization settings of the ASPxClientQueryBuilder properties.
+ * Updates the ASPxClientQueryBuilder properties' localization settings.
* @param localization A dictionary containing the property names, along with their localized equivalents.
*/
UpdateLocalization(localization: { [key: string]: string; }): void;
@@ -29091,6 +31823,16 @@ interface ASPxClientQueryBuilderCustomizeToolbarActionsEventHandler {
*/
(source: S, e: ASPxClientCustomizeMenuActionsEventArgs): void;
}
+/**
+ * A method that will handle the CustomizeLocalization event.
+ */
+interface ASPxClientQueryBuilderCustomizeLocalizationEventHandler {
+ /**
+ * A method that will handle the CustomizeLocalization event.
+ * @param source The event sender.
+ */
+ (source: S): void;
+}
/**
* The client-side equivalent of the Web Report Designer control.
*/
@@ -29104,7 +31846,7 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
*/
EndCallback: ASPxClientEvent>;
/**
- * Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientReportDesigner.
+ * Fires on the client if any server error occurs during server-side processing of a callback sent by ASPxClientReportDesigner.
*/
CallbackError: ASPxClientEvent>;
/**
@@ -29112,7 +31854,7 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
*/
SaveCommandExecute: ASPxClientEvent>;
/**
- * Enables you to customize the menu actions of the Web Report Designer.
+ * Enables you to customize the Web Report Designer's menu actions.
*/
CustomizeMenuActions: ASPxClientEvent>;
/**
@@ -29143,6 +31885,14 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
* Occurs when a report has been opened in the Web Report Designer.
*/
ReportOpened: ASPxClientEvent>;
+ /**
+ * Occurs when a report tab is about to be closed in the Web Report Designer.
+ */
+ ReportTabClosing: ASPxClientEvent>;
+ /**
+ * Occurs when a report tab was closed in the Web Report Designer.
+ */
+ ReportTabClosed: ASPxClientEvent>;
/**
* Occurs on the client each time a server-side error raises.
*/
@@ -29152,7 +31902,7 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
*/
ComponentAdded: ASPxClientEvent>;
/**
- * Enables you to customize UI elements of the Web Report Designer.
+ * Enables you to customize the Web Report Designer's UI elements.
*/
CustomizeElements: ASPxClientEvent>;
/**
@@ -29176,7 +31926,7 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
*/
PreviewDocumentReady: ASPxClientEvent>;
/**
- * Occurs each time a value of an editing field changes in Print Preview.
+ * Occurs each time an editing field's value changes in Print Preview.
*/
PreviewEditingFieldChanged: ASPxClientEvent>;
/**
@@ -29188,17 +31938,25 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
*/
PreviewCustomizeMenuActions: ASPxClientEvent>;
/**
- * Occurs when the left mouse button has been clicked over a report document in Print Preview.
+ * Occurs when the left mouse button is clicked on a report document in Print Preview.
*/
PreviewClick: ASPxClientEvent>;
/**
- * Occurs after report parameter values have been reset to their default values in Print Preview.
+ * Occurs after report parameter values are reset to their default values in Print Preview.
*/
PreviewParametersReset: ASPxClientEvent>;
/**
- * Occurs after report parameter values have been submitted in Print Preview.
+ * Occurs after report parameter values are submitted in Print Preview.
*/
PreviewParametersSubmitted: ASPxClientEvent>;
+ /**
+ * Enables you to customize the Web Report Designer's localization strings.
+ */
+ CustomizeLocalization: ASPxClientEvent>;
+ /**
+ * Occurs before the Web Report Designer UI is initialized.
+ */
+ BeforeRender: ASPxClientEvent>;
/**
* Sends a callback to the server with the specified argument.
* @param arg A String value, specifying the callback argument.
@@ -29211,18 +31969,18 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
*/
PerformCallback(arg: string, onSuccess: (arg1: string) => void): void;
/**
- * Updates the localization settings of the ASPxClientReportDesigner properties.
+ * Updates the Report Designer properties' localization settings.
* @param localization A dictionary containing the property names, along with their localized equivalents.
*/
UpdateLocalization(localization: { [key: string]: string; }): void;
/**
- * Returns the object model of a Web Report Designer.
+ * Provides access to a client-side model of a Web Report Designer.
*/
GetDesignerModel(): Object;
/**
- * Provides access to the preview model of the ASPxClientReportDesigner.
+ * Provides access to the Document Viewer's client-side model.
*/
- GetPreviewModel(): Object;
+ GetPreviewModel(): ASPxClientSidePreviewModel;
/**
* Returns information about the specified property of the specified control.
* @param controlType A string that specifies the control type.
@@ -29313,7 +32071,7 @@ interface ASPxClientReportDesigner extends ASPxClientControl {
*/
ReportStorageGetUrls(): any;
/**
- * Opens the specified report on the client side of the Web Report Designer.
+ * Opens the specified report on the Web Report Designer's client side.
* @param url A string that specifies the URL of a report to be opened.
*/
OpenReport(url: string): void;
@@ -29362,12 +32120,42 @@ interface ASPxClientReportDesignerDialogEventArgs extends ASPxClientEventArgs {
* Value: An object that specifies the report currently being processed.
*/
Report: Object;
+}
+/**
+ * Provides data for the events related to opening and saving reports in the Web Report Designer.
+ */
+interface ASPxClientReportDesignerDialogCancelEventArgs extends ASPxClientReportDesignerDialogEventArgs {
/**
* Specifies whether or not the operation performed with a report should be canceled.
* Value: true, if the operation should be canceled; otherwise, false.
*/
Cancel: boolean;
}
+/**
+ * Provides data for the ReportTabClosed event.
+ */
+interface ASPxClientReportDesignerTabEventArgs extends ASPxClientEventArgs {
+ /**
+ * Specifies the report tab currently being processed.
+ * Value: An object that specifies the report tab currently being processed.
+ */
+ Tab: ASPxDesignerNavigateTab;
+}
+/**
+ * Provides data for the ReportTabClosing event.
+ */
+interface ASPxClientReportDesignerTabClosingEventArgs extends ASPxClientReportDesignerTabEventArgs {
+ /**
+ * Specifies whether or not the event was handled.
+ * Value: true, if the event was handled and no other processing should occur; otherwise, false.
+ */
+ Handled: boolean;
+ /**
+ * Specifies the JQueryDeferred object, which when resolved, forces the report tab to be closed.
+ * Value: A JQueryDeferred object.
+ */
+ ReadyToClose: JQueryDeferred;
+}
/**
* Provides data for the OnServerError event.
*/
@@ -29513,9 +32301,9 @@ interface ASPxClientReportDesignerReportSavingEventHandler {
/**
* A method that will handle the ReportSaving event.
* @param source The event sender.
- * @param e An ASPxClientReportDesignerDialogEventArgs object that contains data related to the event.
+ * @param e An ASPxClientReportDesignerDialogCancelEventArgs object that contains data related to the event.
*/
- (source: S, e: ASPxClientReportDesignerDialogEventArgs): void;
+ (source: S, e: ASPxClientReportDesignerDialogCancelEventArgs): void;
}
/**
* A method that will handle the ReportSaved event.
@@ -29535,9 +32323,9 @@ interface ASPxClientReportDesignerReportOpeningEventHandler {
/**
* A method that will handle the ReportOpening event.
* @param source The event sender.
- * @param e An ASPxClientReportDesignerDialogEventArgs object that contains data related to the event.
+ * @param e An ASPxClientReportDesignerDialogCancelEventArgs object that contains data related to the event.
*/
- (source: S, e: ASPxClientReportDesignerDialogEventArgs): void;
+ (source: S, e: ASPxClientReportDesignerDialogCancelEventArgs): void;
}
/**
* A method that will handle the ReportOpened event.
@@ -29550,6 +32338,28 @@ interface ASPxClientReportDesignerReportOpenedEventHandler {
*/
(source: S, e: ASPxClientReportDesignerDialogEventArgs): void;
}
+/**
+ * A method that will handle the ReportTabClosing event.
+ */
+interface ASPxClientReportDesignerReportTabClosingEventHandler {
+ /**
+ * A method that will handle the ReportTabClosing event.
+ * @param source The event sender.
+ * @param e An ASPxClientReportDesignerTabClosingEventArgs object that contains data related to the event.
+ */
+ (source: S, e: ASPxClientReportDesignerTabClosingEventArgs): void;
+}
+/**
+ * A method that will handle the ReportTabClosed event.
+ */
+interface ASPxClientReportDesignerReportTabClosedEventHandler {
+ /**
+ * A method that will handle the ReportTabClosed event.
+ * @param source The event sender.
+ * @param e An ASPxClientReportDesignerTabEventArgs object that contains data related to the event.
+ */
+ (source: S, e: ASPxClientReportDesignerTabEventArgs): void;
+}
/**
* A method that will handle the OnServerError event.
*/
@@ -29616,6 +32426,27 @@ interface ASPxClientReportDesignerCustomizeToolboxEventHandler {
*/
(source: S, e: ASPxClientReportDesignerCustomizeToolboxEventArgs): void;
}
+/**
+ * A method that will handle the CustomizeLocalization event.
+ */
+interface ASPxClientReportDesignerCustomizeLocalizationEventHandler {
+ /**
+ * A method that will handle the CustomizeLocalization event.
+ * @param source The event sender.
+ */
+ (source: S): void;
+}
+/**
+ * A method that will handle the BeforeRender event.
+ */
+interface ASPxClientReportDesignerBeforeRenderEventHandler {
+ /**
+ * A method that will handle the BeforeRender event.
+ * @param source The event sender.
+ * @param designerModel A client-side Report Designer model.
+ */
+ (source: S, designerModel: Object): void;
+}
/**
* Provides information about a value editor used in the Property Grid.
*/
@@ -29994,7 +32825,7 @@ interface ASPxClientReportViewer extends ASPxClientControl {
*/
EndCallback: ASPxClientEvent>;
/**
- * Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientReportViewer.
+ * Fires on the client if any server error occurs during server-side processing of a callback sent by ASPxClientReportViewer.
*/
CallbackError: ASPxClientEvent>;
/**
@@ -30147,10 +32978,10 @@ interface ASPxClientMenuAction {
*/
hotKey: ASPxClientMenuActionHotKey;
/**
- * Provides access to the value that specifies whether or not the command has a visual separator.
+ * Specifies whether or not the command has a visual separator.
* Value: true, if the command has a visual separator; otherwise, false.
*/
- hasSeparator: string;
+ hasSeparator: boolean;
/**
* Provides access to a value that specifies the command location.
* Value: A string that specifies the command location.
@@ -30505,6 +33336,11 @@ interface ASPxClientPreviewClickEventArgs extends ASPxClientEventArgs {
* Returns a string providing additional information on the Brick.
*/
GetBrickValue(): string;
+ /**
+ * Returns a string providing additional information about the current Brick by the specified key.
+ * @param key A string that specifies a unique key.
+ */
+ GetBrickValue(key: string): string;
}
/**
* Provides information about a visual brick used to render a report control to construct a document in the Web Document Viewer.
@@ -30571,19 +33407,19 @@ interface ASPxClientWebDocumentViewerBrickNavigation {
*/
interface ASPxClientWebDocumentViewer extends ASPxClientControl {
/**
- * Occurs after a report document has been loaded to the Web Document Viewer.
+ * Occurs after the Web Document Viewer loads a report document.
*/
DocumentReady: ASPxClientEvent>;
/**
- * Occurs each time a value of an editing field changes.
+ * Occurs each time an editing field's value changes.
*/
EditingFieldChanged: ASPxClientEvent>;
/**
- * Enables you to customize UI elements of the Web Document Viewer.
+ * Allows you to customize the Web Document Viewer's UI elements.
*/
CustomizeElements: ASPxClientEvent>;
/**
- * Enables you to customize the menu actions of a Web Document Viewer.
+ * Enables you to customize the Web Document Viewer's menu actions.
*/
CustomizeMenuActions: ASPxClientEvent>;
/**
@@ -30595,27 +33431,44 @@ interface ASPxClientWebDocumentViewer extends ASPxClientControl {
*/
CustomizeParameterLookUpSource: ASPxClientEvent>;
/**
- * Occurs when the left mouse button has been clicked over a report document.
+ * Occurs when the left mouse button is clicked on a report document.
*/
PreviewClick: ASPxClientEvent>;
/**
- * Occurs after report parameter values have been reset to their default values.
+ * Occurs after report parameter values are reset to their default values.
*/
ParametersReset: ASPxClientEvent>;
/**
- * Occurs after report parameter values have been submitted.
+ * Occurs after report parameter values are submitted.
*/
ParametersSubmitted: ASPxClientEvent>;
/**
- * Provides access to the preview model of the ASPxClientWebDocumentViewer.
+ * Enables you to customize the Web Document Viewer's localization strings.
*/
- GetPreviewModel(): Object;
+ CustomizeLocalization: ASPxClientEvent>;
/**
- * Returns a model for a report parameter.
+ * Occurs before the Web Document Viewer UI is initialized.
*/
- GetParametersModel(): Object;
+ BeforeRender: ASPxClientEvent>;
/**
- * Opens the specified report on the client side of the Web Document Viewer.
+ * Provides access to the Document Viewer's client-side model.
+ */
+ GetPreviewModel(): ASPxClientSidePreviewModel;
+ /**
+ * Provides access to the report preview.
+ */
+ GetReportPreview(): ASPxClientReportPreview;
+ /**
+ * Provide access to the report parameters' client-side model.
+ */
+ GetParametersModel(): ASPxClientSideParametersModel;
+ /**
+ * Enables navigation between drill-through reports on the client-side.
+ * @param customData Provides access to custom client data associated with a currently previewed report.
+ */
+ DrillThrough(customData: string): any;
+ /**
+ * Opens the specified report on the Web Document Viewer's client side.
* @param url A string that specifies the URL of a report to be opened.
*/
OpenReport(url: string): any;
@@ -30644,7 +33497,7 @@ interface ASPxClientWebDocumentViewer extends ASPxClientControl {
*/
ExportTo(format: string, inlineResult: boolean): void;
/**
- * Returns the zero-based index of the currently displayed page.
+ * Returns the current page's zero-based index.
*/
GetCurrentPageIndex(): number;
/**
@@ -30653,11 +33506,11 @@ interface ASPxClientWebDocumentViewer extends ASPxClientControl {
*/
GoToPage(pageIndex: number): void;
/**
- * Closes the document currently being opened in the Web Document Viewer.
+ * Closes the document which is currently opened in the Web Document Viewer.
*/
Close(): void;
/**
- * Resets the values of report parameters to their default values.
+ * Resets the report parameter values to the default values.
*/
ResetParameters(): void;
/**
@@ -30665,7 +33518,22 @@ interface ASPxClientWebDocumentViewer extends ASPxClientControl {
*/
StartBuild(): void;
/**
- * Updates the localization settings of the ASPxClientWebDocumentViewer properties.
+ * Performs a custom operation with a currently opened document on the client side.
+ */
+ PerformCustomDocumentOperation(): any;
+ /**
+ * Performs a custom operation with a currently opened document on the client-side.
+ * @param customData Provides access to custom client data associated with a target document operation.
+ */
+ PerformCustomDocumentOperation(customData: string): any;
+ /**
+ * Performs a custom operation with a currently opened document on the client-side.
+ * @param customData Provides access to custom client data associated with a target document operation.
+ * @param hideMessageFromUser true, to hide a message with the operation result from a user; otherwise, false.
+ */
+ PerformCustomDocumentOperation(customData: string, hideMessageFromUser: boolean): any;
+ /**
+ * Updates the Web Document Viewer properties' localization settings.
* @param localization A dictionary containing the property names, along with their localized equivalents.
*/
UpdateLocalization(localization: { [key: string]: string; }): void;
@@ -30769,6 +33637,219 @@ interface ASPxClientWebDocumentViewerParametersSubmittedEventHandler {
*/
(source: S, e: ASPxClientParametersSubmittedEventArgs): void;
}
+/**
+ * A method that will handle the CustomizeLocalization event.
+ */
+interface ASPxClientWebDocumentViewerCustomizeLocalizationEventHandler {
+ /**
+ * A method that will handle the CustomizeLocalization event.
+ * @param source The event sender.
+ */
+ (source: S): void;
+}
+/**
+ * A method that will handle the BeforeRender event.
+ */
+interface ASPxClientWebDocumentViewerBeforeRenderEventHandler {
+ /**
+ * A method that will handle the BeforeRender event.
+ * @param source The event sender.
+ * @param previewModel A client-side Document Viewer model.
+ */
+ (source: S, previewModel: Object): void;
+}
+/**
+ * Provides information about the result of preforming a custom document operation on the client side.
+ */
+interface ASPxClientWebDocumentViewerDocumentOperationResponse {
+ /**
+ * Specifies whether a document operation has been successfully performed.
+ * Value: true, if the document operation has been successfully performed; otherwise, false.
+ */
+ succeeded: boolean;
+ /**
+ * Specifies the error message to display if performing a document operation fails.
+ * Value: A string specifying the text of the error message.
+ */
+ message: string;
+ /**
+ * Specifies custom data associated with the performed document operation.
+ * Value: A string containing information associated with the document operation.
+ */
+ customData: string;
+ /**
+ * Specifies the document ID.
+ * Value: A string that specifies the document ID.
+ */
+ documentId: string;
+}
+/**
+ * Provides information a client-side Document Preview model.
+ */
+interface ASPxClientSidePreviewModel {
+ /**
+ * Provides access to the report preview.
+ * Value: An object that specifies the report preview.
+ */
+ reportPreview: ASPxClientReportPreview;
+ /**
+ * Provides access to a panel at the right of the Document Viewer.
+ * Value: An object that specifies the panel at the right of the Document Viewer.
+ */
+ tabPanel: ASPxClientDocumentPreviewTabPanel;
+ /**
+ * Opens the specified report on the Web Document Viewer's client side.
+ * @param url A string that specifies the URL of a report to be opened.
+ */
+ OpenReport(url: string): any;
+ /**
+ * Prints the current document.
+ */
+ Print(): void;
+ /**
+ * Prints the document's page with the specified index.
+ * @param pageIndex An index of the page to be printed.
+ */
+ Print(pageIndex: number): void;
+ /**
+ * Exports the document to a PDF file.
+ */
+ ExportTo(): void;
+ /**
+ * Exports the document to a specified file format.
+ * @param format A String value, specifying the export format. The following formats are currently supported: 'csv', 'html', 'image', 'mht', 'pdf', 'rtf', 'docx', 'txt', 'xls', and 'xlsx'.
+ */
+ ExportTo(format: string): void;
+ /**
+ * Exports the document to a specified file format.
+ * @param format A String value that specifies the export format. The following formats are currently supported: 'csv', 'html', 'image', 'mht', 'pdf', 'rtf', 'docx', 'txt', 'xls', and 'xlsx'.
+ * @param inlineResult true, to try opening the result file in a new browser tab without a download; otherwise, false.
+ */
+ ExportTo(format: string, inlineResult: boolean): void;
+ /**
+ * Returns the current page's zero-based index.
+ */
+ GetCurrentPageIndex(): number;
+ /**
+ * Displays the report page with the specified page index.
+ * @param pageIndex A zero-based integer value that specifies the index of a page to be displayed.
+ */
+ GoToPage(pageIndex: number): void;
+ /**
+ * Closes the document which is currently opened in the Web Document Viewer.
+ */
+ Close(): void;
+ /**
+ * Resets the report parameter values to the default values.
+ */
+ ResetParameters(): void;
+ /**
+ * Starts building a report document.
+ */
+ StartBuild(): void;
+ /**
+ * Provide access to the report parameters' client-side model.
+ */
+ GetParametersModel(): ASPxClientSideParametersModel;
+}
+/**
+ * Provides information about the Document Viewer's tab panel.
+ */
+interface ASPxClientDocumentPreviewTabPanel {
+ /**
+ * Specifies the width of the panel at the right of the Document Viewer.
+ * Value: A knockout observable object that specifies the tab panel width.
+ */
+ width: any;
+ /**
+ * Specifies whether the panel at the right of the Document Viewer is collapsed.
+ * Value: A knockout observable object that specifies whether the tab panel is collapsed.
+ */
+ collapsed: any;
+ /**
+ * Provides access to the tabs of the panel at the right of the Document Viewer.
+ * Value: A collection of ASPxClientDocumentPreviewTab objects.
+ */
+ tabs: ASPxClientDocumentPreviewTab[];
+}
+/**
+ * Provides information about a tab available in the Document Viewer.
+ */
+interface ASPxClientDocumentPreviewTab {
+ /**
+ * Provides access to the name of an HTML template used by a tab.
+ * Value: A knockout observable string that specifies the name of the HTML template used by the tab.
+ */
+ template: string;
+ /**
+ * Provides access to the tab text.
+ * Value: A string that specifies the tab text.
+ */
+ text: string;
+ /**
+ * Provides access to a tab model.
+ * Value: An object that specifies the tab model.
+ */
+ model: Object;
+ /**
+ * Provides access to the value that specifies whether a tab is active.
+ * Value: A knockout observable object that specifies whether the tab is active.
+ */
+ active: any;
+ /**
+ * Provides access to the value that specifies whether a tab is visible.
+ * Value: A knockout observable object that specifies whether the tab is visible.
+ */
+ visible: any;
+}
+/**
+ * Provides information about the report parameters' client-side model.
+ */
+interface ASPxClientSideParametersModel {
+ /**
+ * Provides information about the tab for specifying parameter values.
+ * Value: An object that provides information about the Parameters tab.
+ */
+ tabInfo: ASPxClientDocumentPreviewTab;
+ /**
+ * Initiates passing parameter values and generating the report document.
+ */
+ submit(): void;
+ /**
+ * Serializes report parameters before passing them to the server.
+ */
+ serializeParameters(): void;
+}
+/**
+ * Provides information about a report preview.
+ */
+interface ASPxClientReportPreview {
+ /**
+ * Zooms the Document Viewer's current document.
+ * Value: A knockout observable object that specifies the zoom factor.
+ */
+ zoom: any;
+ /**
+ * Enables the Document Viewer's multi-page mode.
+ * Value: A knockout observable object that specifies whether the multi-page mode is enabled.
+ */
+ showMultipagePreview: any;
+ /**
+ * Provides access to the current document page's index.
+ * Value: A knockout observable object that specifies the zero-based index of the current page.
+ */
+ pageIndex: any;
+ /**
+ * Provides access to document pages.
+ * Value: An array of objects that specify document pages.
+ */
+ pages: any;
+ /**
+ * Provides access to a value that specifies whether the document is currently building.
+ * Value: A knockout observable object that specifies whether the document is building.
+ */
+ documentBuilding: any;
+}
interface MVCxClientDashboardViewerStatic extends ASPxClientDashboardViewerStatic {
}
@@ -30812,7 +33893,7 @@ interface DashboardSpecialValuesStatic {
*/
OthersValue: string;
/**
- * Represents an error value for calculated fields.
+ * Represents an error value (for instance, this can be a calculated field value that cannot be evaluated).
*/
ErrorValue: string;
/**
@@ -30890,6 +33971,20 @@ interface DashboardExportScaleModeStatic {
*/
AutoFitWithinOnePage: string;
}
+interface DashboardExportDocumentScaleModeStatic {
+ /**
+ * The dashboard / dashboard item on the exported page retains its original size.
+ */
+ None: string;
+ /**
+ * The size of the dashboard / dashboard item on the exported page is changed according to the scale factor value (ScaleFactor).
+ */
+ UseScaleFactor: string;
+ /**
+ * The size of the dashboard / dashboard item is changed according to the width of the exported pages.
+ */
+ AutoFitToPagesWidth: string;
+}
interface DashboardExportFilterStateStatic {
/**
* The filter state is not included in the exported document.
@@ -31156,6 +34251,18 @@ interface ASPxClientEditStatic extends ASPxClientEditBaseStatic {
* Verifies whether visible editors on a page are valid.
*/
AreEditorsValid(): boolean;
+ /**
+ * Attaches a handler to the ASPxClientEdit's event indicating whether the editor has been changed since the previous state.
+ * @param handler An object representing a handler.
+ * @param predicate An ASPxClientControlPredicate object representing the predicate criteria.
+ */
+ AttachEditorModificationListener(handler: Object, predicate: ASPxClientControlPredicate): void;
+ /**
+ * Detaches a handler from the editor's event if the editor meets the predicate criteria.
+ * @param handler An object representing a handler.
+ * @param predicate An ASPxClientControlPredicate object representing a predicate criteria.
+ */
+ DetachEditorModificationListener(handler: Object, predicate: ASPxClientControlPredicate): void;
}
interface ASPxClientBinaryImageStatic extends ASPxClientEditStatic {
/**
@@ -31538,11 +34645,41 @@ interface ASPxClientGridViewCallbackCommandStatic {
* Default value: "TOOLBAR"
*/
Toolbar: string;
+ /**
+ * Default value: "EXPORT"
+ */
+ Export: string;
/**
* Default value: "CUSTOMVALUES"
*/
CustomValues: string;
}
+interface ASPxClientGridExportFormatStatic {
+ /**
+ * Identifies Portable Document Format (.pdf).
+ */
+ Pdf: string;
+ /**
+ * Identifies DOCX format (.docx).
+ */
+ Docx: string;
+ /**
+ * Identifies Rich Text Format (.rtf).
+ */
+ Rtf: string;
+ /**
+ * Identifies Comma Separated Values format (.csv).
+ */
+ Csv: string;
+ /**
+ * Identifies Excel Binary File format (.xls).
+ */
+ Xls: string;
+ /**
+ * Identifies XML spreadsheet file format (.xlsx).
+ */
+ Xlsx: string;
+}
interface ASPxClientGridLookupStatic extends ASPxClientDropDownEditBaseStatic {
/**
* Converts the specified object to the current object's type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
@@ -31557,6 +34694,8 @@ interface ASPxClientCardViewStatic extends ASPxClientGridBaseStatic {
*/
Cast(obj: Object): ASPxClientCardView;
}
+interface ASPxClientCardViewExportFormatStatic extends ASPxClientGridExportFormatStatic {
+}
interface ASPxClientGridViewStatic extends ASPxClientGridBaseStatic {
/**
* Converts the specified object to the current object's type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
@@ -31564,6 +34703,8 @@ interface ASPxClientGridViewStatic extends ASPxClientGridBaseStatic {
*/
Cast(obj: Object): ASPxClientGridView;
}
+interface ASPxClientGridViewExportFormatStatic extends ASPxClientGridExportFormatStatic {
+}
interface ASPxClientVerticalGridStatic extends ASPxClientGridBaseStatic {
/**
* Converts the specified object to the current object's type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
@@ -31577,6 +34718,8 @@ interface ASPxClientVerticalGridCallbackCommandStatic {
*/
ExpandRow: string;
}
+interface ASPxClientVerticalGridExportFormatStatic extends ASPxClientGridExportFormatStatic {
+}
interface ASPxClientCommandConstsStatic {
/**
* Identifies a command that shows a search panel.
@@ -32106,6 +35249,27 @@ interface ASPxClientHtmlEditorStatic extends ASPxClientControlStatic {
* @param data An object representing custom data associated with a custom dialog.
*/
CustomDialogComplete(status: Object, data: Object): void;
+ /**
+ * Highlights the text.
+ * @param text A string value specifying the text to be highlighted.
+ * @param searchContainer An object specifying the container where the specified text should be searched.
+ */
+ HighlightText(text: string, searchContainer: Object): void;
+ /**
+ * Highlights the text with the specified settings.
+ * @param text A string value specifying the text to be highlighted.
+ * @param searchContainer An object specifying the container where the specified text should be searched.
+ * @param className A string value specifying the text color.
+ */
+ HighlightText(text: string, searchContainer: Object, className: string): void;
+ /**
+ * Highlights the text with the specified text color and background color.
+ * @param text A string value specifying the text to be highlighted.
+ * @param searchContainer An object specifying the container where the specified text should be searched.
+ * @param color A string value specifying the text color.
+ * @param backgroundColor A string value specifying the background color.
+ */
+ HighlightText(text: string, searchContainer: Object, color: string, backgroundColor: string): void;
}
interface ASPxClientHtmlEditorMediaPreloadModeStatic {
/**
@@ -32229,6 +35393,28 @@ interface ASPxClientTreeListStatic extends ASPxClientControlStatic {
*/
Cast(obj: Object): ASPxClientTreeList;
}
+interface ASPxClientTreeListExportFormatStatic {
+ /**
+ * Identifies Portable Document Format (.pdf).
+ */
+ Pdf: string;
+ /**
+ * Identifies DOCX format (.docx).
+ */
+ Docx: string;
+ /**
+ * Identifies Rich Text Format (.rtf).
+ */
+ Rtf: string;
+ /**
+ * Identifies Excel Binary File format (.xls).
+ */
+ Xls: string;
+ /**
+ * Identifies XML spreadsheet file format (.xlsx).
+ */
+ Xlsx: string;
+}
interface BootstrapClientAccordionStatic extends ASPxClientNavBarStatic {
}
interface BootstrapClientBinaryImageStatic extends ASPxClientHyperLinkStatic {
@@ -32239,14 +35425,6 @@ interface BootstrapClientCalendarStatic extends ASPxClientCalendarStatic {
}
interface BootstrapClientCallbackPanelStatic extends ASPxClientControlStatic {
}
-interface BootstrapClientChartBaseStatic extends ASPxClientControlStatic {
-}
-interface BootstrapClientChartStatic extends BootstrapClientChartBaseStatic {
-}
-interface BootstrapClientPolarChartStatic extends BootstrapClientChartBaseStatic {
-}
-interface BootstrapClientPieChartStatic extends BootstrapClientChartBaseStatic {
-}
interface BootstrapClientCheckBoxStatic extends ASPxClientEditStatic {
}
interface BootstrapClientRadioButtonStatic extends BootstrapClientCheckBoxStatic {
@@ -32281,24 +35459,45 @@ interface BootstrapClientProgressBarStatic extends ASPxClientProgressBarStatic {
}
interface BootstrapClientSpinEditStatic extends ASPxClientSpinEditStatic {
}
+interface BootstrapClientTimeEditStatic extends ASPxClientTimeEditStatic {
+}
interface BootstrapClientTabControlStatic extends ASPxClientTabControlStatic {
}
interface BootstrapClientPageControlStatic extends ASPxClientPageControlStatic {
}
+interface BootstrapClientTagBoxStatic extends ASPxClientTokenBoxStatic {
+}
interface BootstrapClientTextBoxStatic extends ASPxClientTextBoxStatic {
}
interface BootstrapClientMemoStatic extends ASPxClientMemoStatic {
}
interface BootstrapClientButtonEditStatic extends ASPxClientButtonEditStatic {
}
-interface BootstrapClientTreeViewStatic extends ASPxClientTreeViewStatic {
+interface BootstrapClientToolbarStatic extends BootstrapClientMenuStatic {
}
-interface BootstrapUIWidgetBaseStatic extends ASPxClientControlStatic {
+interface BootstrapClientTreeViewStatic extends ASPxClientTreeViewStatic {
}
interface BootstrapClientUploadControlStatic extends ASPxClientUploadControlStatic {
}
+interface BootstrapClientUtilsStatic {
+ UpdateDefaultStyles(): void;
+}
interface BootstrapClientGridViewStatic extends ASPxClientGridViewStatic {
}
+interface BootstrapClientCardViewStatic extends ASPxClientGridViewStatic {
+}
+interface BootstrapUIWidgetBaseStatic extends ASPxClientControlStatic {
+}
+interface BootstrapClientChartBaseStatic extends BootstrapUIWidgetBaseStatic {
+}
+interface BootstrapClientChartStatic extends BootstrapClientChartBaseStatic {
+}
+interface BootstrapClientPolarChartStatic extends BootstrapClientChartBaseStatic {
+}
+interface BootstrapClientPieChartStatic extends BootstrapClientChartBaseStatic {
+}
+interface BootstrapClientRangeSelectorStatic extends BootstrapUIWidgetBaseStatic {
+}
interface MVCxClientCalendarStatic extends ASPxClientCalendarStatic {
/**
* Converts the specified object to the current object's type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
@@ -32728,6 +35927,28 @@ interface ASPxClientFileManagerErrorConstsStatic {
*/
AlreadyExists: number;
}
+interface ASPxClientFileManagerCallbackCommandStatic {
+ GetAllItems: string;
+ GetFileList: string;
+ Refresh: string;
+ DeleteItems: string;
+ MoveItems: string;
+ CopyItems: string;
+ RenameItem: string;
+ Download: string;
+ ShowFolderBrowserDialog: string;
+ ShowCreateFolderEditorInTreeView: string;
+ CreateFolder: string;
+ SelectedFileOpened: string;
+ FoldersTreeView: string;
+ FolderBrowserTreeView: string;
+ GridView: string;
+ ChangeFolder: string;
+ ChangeFolderInTreeView: string;
+ CustomCallback: string;
+ VirtualScrolling: string;
+ GridViewVirtualScrolling: string;
+}
interface ASPxClientFormLayoutStatic extends ASPxClientControlStatic {
/**
* Converts the specified object to the current object's type. This method is effective when you utilize the Client API IntelliSense feature provided by DevExpress.
@@ -33384,10 +36605,10 @@ interface ASPxClientUtilsStatic {
DeleteCookie(name: string): void;
/**
* Returns a specifically generated code that uniquely identifies the combination of keys specified via the parameters.
- * @param keyCode An integer value that specifies the code of the key.
- * @param isCtrlKey true if the CTRL key should be included into the key combination; otherwise, false.
- * @param isShiftKey true if the SHIFT key should be included into the key combination; otherwise, false.
- * @param isAltKey true if the ALT key should be included into the key combination; otherwise, false.
+ * @param keyCode An integer value that specifies the code of the key. Codes are available via the ASPx.KeyCode client object's members.
+ * @param isCtrlKey true, if the CTRL key should be included into the key combination; otherwise, false.
+ * @param isShiftKey true, if the SHIFT key should be included into the key combination; otherwise, false.
+ * @param isAltKey true, if the ALT key should be included into the key combination; otherwise, false.
*/
GetShortcutCode(keyCode: number, isCtrlKey: boolean, isShiftKey: boolean, isAltKey: boolean): number;
/**
@@ -33415,6 +36636,17 @@ interface ASPxClientUtilsStatic {
* @param str A string value representing the string for trimming.
*/
TrimEnd(str: string): string;
+ /**
+ * Returns values of editors located in the specified container.
+ * @param containerOrId A container of editors, or its ID.
+ */
+ GetEditorValuesInContainer(containerOrId: Object): Object;
+ /**
+ * Returns values of editors located in the specified container.
+ * @param containerOrId A container of editors, or its ID.
+ * @param processInvisibleEditors true to process both visible and invisible editors that belong to the specified container; false to process only visible editors.
+ */
+ GetEditorValuesInContainer(containerOrId: Object, processInvisibleEditors: boolean): Object;
/**
* Specifies the text that Assistive Technologies (screen readers or braille display, for example) will provide to a user.
* @param message A String value that specifies a text.
@@ -33488,6 +36720,7 @@ declare var DashboardSpecialValues: DashboardSpecialValuesStatic;
declare var DashboardExportPageLayout: DashboardExportPageLayoutStatic;
declare var DashboardExportPaperKind: DashboardExportPaperKindStatic;
declare var DashboardExportScaleMode: DashboardExportScaleModeStatic;
+declare var DashboardExportDocumentScaleMode: DashboardExportDocumentScaleModeStatic;
declare var DashboardExportFilterState: DashboardExportFilterStateStatic;
declare var DashboardStateExportPosition: DashboardStateExportPositionStatic;
declare var DashboardStateExcelExportPosition: DashboardStateExcelExportPositionStatic;
@@ -33541,11 +36774,15 @@ declare var ASPxClientValidationSummary: ASPxClientValidationSummaryStatic;
declare var ASPxClientGaugeControl: ASPxClientGaugeControlStatic;
declare var ASPxClientGridBase: ASPxClientGridBaseStatic;
declare var ASPxClientGridViewCallbackCommand: ASPxClientGridViewCallbackCommandStatic;
+declare var ASPxClientGridExportFormat: ASPxClientGridExportFormatStatic;
declare var ASPxClientGridLookup: ASPxClientGridLookupStatic;
declare var ASPxClientCardView: ASPxClientCardViewStatic;
+declare var ASPxClientCardViewExportFormat: ASPxClientCardViewExportFormatStatic;
declare var ASPxClientGridView: ASPxClientGridViewStatic;
+declare var ASPxClientGridViewExportFormat: ASPxClientGridViewExportFormatStatic;
declare var ASPxClientVerticalGrid: ASPxClientVerticalGridStatic;
declare var ASPxClientVerticalGridCallbackCommand: ASPxClientVerticalGridCallbackCommandStatic;
+declare var ASPxClientVerticalGridExportFormat: ASPxClientVerticalGridExportFormatStatic;
declare var ASPxClientCommandConsts: ASPxClientCommandConstsStatic;
declare var ASPxClientHtmlEditor: ASPxClientHtmlEditorStatic;
declare var ASPxClientHtmlEditorMediaPreloadMode: ASPxClientHtmlEditorMediaPreloadModeStatic;
@@ -33567,15 +36804,12 @@ declare var ASPxClientSpellChecker: ASPxClientSpellCheckerStatic;
declare var ASPxClientSpellCheckerStopCheckingReason: ASPxClientSpellCheckerStopCheckingReasonStatic;
declare var ASPxClientSpreadsheet: ASPxClientSpreadsheetStatic;
declare var ASPxClientTreeList: ASPxClientTreeListStatic;
+declare var ASPxClientTreeListExportFormat: ASPxClientTreeListExportFormatStatic;
declare var BootstrapClientAccordion: BootstrapClientAccordionStatic;
declare var BootstrapClientBinaryImage: BootstrapClientBinaryImageStatic;
declare var BootstrapClientButton: BootstrapClientButtonStatic;
declare var BootstrapClientCalendar: BootstrapClientCalendarStatic;
declare var BootstrapClientCallbackPanel: BootstrapClientCallbackPanelStatic;
-declare var BootstrapClientChartBase: BootstrapClientChartBaseStatic;
-declare var BootstrapClientChart: BootstrapClientChartStatic;
-declare var BootstrapClientPolarChart: BootstrapClientPolarChartStatic;
-declare var BootstrapClientPieChart: BootstrapClientPieChartStatic;
declare var BootstrapClientCheckBox: BootstrapClientCheckBoxStatic;
declare var BootstrapClientRadioButton: BootstrapClientRadioButtonStatic;
declare var BootstrapClientComboBox: BootstrapClientComboBoxStatic;
@@ -33593,15 +36827,25 @@ declare var BootstrapClientPopupControl: BootstrapClientPopupControlStatic;
declare var BootstrapClientPopupMenu: BootstrapClientPopupMenuStatic;
declare var BootstrapClientProgressBar: BootstrapClientProgressBarStatic;
declare var BootstrapClientSpinEdit: BootstrapClientSpinEditStatic;
+declare var BootstrapClientTimeEdit: BootstrapClientTimeEditStatic;
declare var BootstrapClientTabControl: BootstrapClientTabControlStatic;
declare var BootstrapClientPageControl: BootstrapClientPageControlStatic;
+declare var BootstrapClientTagBox: BootstrapClientTagBoxStatic;
declare var BootstrapClientTextBox: BootstrapClientTextBoxStatic;
declare var BootstrapClientMemo: BootstrapClientMemoStatic;
declare var BootstrapClientButtonEdit: BootstrapClientButtonEditStatic;
+declare var BootstrapClientToolbar: BootstrapClientToolbarStatic;
declare var BootstrapClientTreeView: BootstrapClientTreeViewStatic;
-declare var BootstrapUIWidgetBase: BootstrapUIWidgetBaseStatic;
declare var BootstrapClientUploadControl: BootstrapClientUploadControlStatic;
+declare var BootstrapClientUtils: BootstrapClientUtilsStatic;
declare var BootstrapClientGridView: BootstrapClientGridViewStatic;
+declare var BootstrapClientCardView: BootstrapClientCardViewStatic;
+declare var BootstrapUIWidgetBase: BootstrapUIWidgetBaseStatic;
+declare var BootstrapClientChartBase: BootstrapClientChartBaseStatic;
+declare var BootstrapClientChart: BootstrapClientChartStatic;
+declare var BootstrapClientPolarChart: BootstrapClientPolarChartStatic;
+declare var BootstrapClientPieChart: BootstrapClientPieChartStatic;
+declare var BootstrapClientRangeSelector: BootstrapClientRangeSelectorStatic;
declare var MVCxClientCalendar: MVCxClientCalendarStatic;
declare var MVCxClientCallbackPanel: MVCxClientCallbackPanelStatic;
declare var MVCxClientCardView: MVCxClientCardViewStatic;
@@ -33651,6 +36895,7 @@ declare var ASPxClientDockZone: ASPxClientDockZoneStatic;
declare var ASPxClientFileManager: ASPxClientFileManagerStatic;
declare var ASPxClientFileManagerCommandConsts: ASPxClientFileManagerCommandConstsStatic;
declare var ASPxClientFileManagerErrorConsts: ASPxClientFileManagerErrorConstsStatic;
+declare var ASPxClientFileManagerCallbackCommand: ASPxClientFileManagerCallbackCommandStatic;
declare var ASPxClientFormLayout: ASPxClientFormLayoutStatic;
declare var ASPxClientHiddenField: ASPxClientHiddenFieldStatic;
declare var ASPxClientHint: ASPxClientHintStatic;
diff --git a/types/devexpress-web/v171/devexpress-web-tests.ts b/types/devexpress-web/v171/devexpress-web-tests.ts
new file mode 100644
index 0000000000..ef7eb8de37
--- /dev/null
+++ b/types/devexpress-web/v171/devexpress-web-tests.ts
@@ -0,0 +1,418 @@
+declare var hiddenField: ASPxClientHiddenField;
+declare var mainCallbackPanel: ASPxClientCallbackPanel;
+declare var loginPopup: ASPxClientPopupControl;
+declare var searchButton: ASPxClientButton;
+declare var searchComboBox: ASPxClientComboBox;
+declare var roomsNumberSpinEdit: ASPxClientSpinEdit;
+declare var adultsNumberSpinEdit: ASPxClientSpinEdit;
+declare var childrenNumberSpinEdit: ASPxClientSpinEdit;
+declare var checkInDateEdit: ASPxClientDateEdit;
+declare var checkOutDateEdit: ASPxClientDateEdit;
+declare var backSlider: ASPxClientImageSlider;
+declare var locationComboBox: ASPxClientComboBox;
+declare var nightyRateTrackBar: ASPxClientTrackBar;
+declare var customerRatingTrackBar: ASPxClientTrackBar;
+declare var ourRatingCheckBoxList: ASPxClientCheckBoxList;
+declare var startFilterPopupControl: ASPxClientPopupControl;
+declare var imagePopupControl: ASPxClientPopupControl;
+declare var emailTextBox: ASPxClientTextBox;
+declare var creditCardEmailTextBox: ASPxClientTextBox;
+declare var accountEmailTextBox: ASPxClientTextBox;
+declare var bookingPageControl: ASPxClientPageControl;
+declare var paymentTypePageControl: ASPxClientPageControl;
+declare var offerFormPopup: ASPxClientPopupControl;
+declare var roomsSpinEdit: ASPxClientSpinEdit;
+declare var adultsSpinEdit: ASPxClientSpinEdit;
+declare var childrenSpinEdit: ASPxClientSpinEdit;
+declare var hotelDetailsCallbackPanel: ASPxClientCallbackPanel;
+declare var leftPanel: ASPxClientPanel;
+declare var menuButton: ASPxClientButton;
+declare var aboutWindow: ASPxClientPopupControl;
+declare var offersZone: ASPxClientDockZone;
+
+module DXDemo {
+ function showPage(page: string, params: { [key: string]: any }, skipHistory?: boolean): void {
+ var queryString = getQueryString(params || {});
+ hiddenField.Set("page", page);
+ hiddenField.Set("parameters", queryString);
+ hideMenu();
+ var uri = queryString.length ? (page + "?" + queryString) : page;
+ try {
+ if (!skipHistory && window.history && window.history.pushState)
+ window.history.pushState(uri, "", uri || "Default.aspx");
+ } catch (e) { }
+ mainCallbackPanel.PerformCallback(uri);
+ };
+
+ export function onMainMenuItemClick(s: ASPxClientMenu, e: ASPxClientMenuItemClickEventArgs): void {
+ switch (e.item.name) {
+ case "login":
+ hideMenu();
+ setTimeout(function () { loginPopup.ShowAtElementByID("MainCallbackPanel_ContentPane"); }, 300);
+ break;
+ case "offers":
+ showPage("SpecialOffers", {});
+ break;
+ default:
+ hideMenu();
+ setTimeout(function () { showAboutWindow(); }, 300);
+ break;
+ }
+ };
+
+ export function onLoginButtonClick(s: ASPxClientButton, e: ASPxClientButtonClickEventArgs): void {
+ loginPopup.Hide();
+ showAboutWindow();
+ };
+
+ export function onSearchButtonClick(): void {
+ if (ASPxClientEdit.ValidateGroup("DateEditors")) {
+ showPage("ShowHotels", {
+ location: searchComboBox.GetValue(),
+ checkin: getFormattedDate(checkInDateEdit.GetValue()),
+ checkout: getFormattedDate(checkOutDateEdit.GetValue()),
+ rooms: roomsNumberSpinEdit.GetValue() || 1,
+ adults: adultsNumberSpinEdit.GetValue() || 1,
+ children: childrenNumberSpinEdit.GetValue() || 0
+ });
+ }
+ };
+
+ export function onSearchComboBoxIndexChanged(s: ASPxClientComboBox, e: ASPxClientProcessingModeEventArgs): void {
+ hideMenu();
+ searchButton.AdjustControl();
+ };
+
+ export function onIndexOfferCloseClick(index: number): void {
+ var panel = ASPxClientControl.GetControlCollection().GetByName("OfferDockPanel" + index);
+ var sibPanel = ASPxClientControl.GetControlCollection().GetByName("OfferDockPanel" + (index == 1 ? 2 : 1));
+ panel.Hide();
+ sibPanel.MakeFloat();
+ sibPanel.SetWidth(offersZone.GetWidth());
+ sibPanel.Dock(offersZone);
+ };
+
+ export function onLogoClick(): void {
+ showPage("", null, false);
+ };
+
+ export function onMenuNavButtonCheckedChanged(s: ASPxClientCheckBox, e: ASPxClientProcessingModeEventArgs): void {
+ var mainContainer = mainCallbackPanel.GetMainElement();
+ if (s.GetChecked()) {
+ backSlider.Pause();
+ showMenu();
+ }
+ else {
+ hideMenu();
+ backSlider.Play();
+ }
+ };
+
+ export function onBackNavButtonClick(s: ASPxClientButton, e: ASPxClientButtonClickEventArgs): void {
+ var params = getCurrentQueryParams();
+ switch (getCurrentPage()) {
+ case "PrintInvoice":
+ showPage("Booking", params, false);
+ break;
+ case "Booking":
+ if (bookingPageControl.GetActiveTabIndex() > 0)
+ bookingPageControl.SetActiveTabIndex(bookingPageControl.GetActiveTabIndex() - 1);
+ else
+ showPage("ShowRooms", params, false);
+ break;
+ case "ShowRooms":
+ showPage("ShowHotels", params, false);
+ break;
+ case "ShowDetails":
+ showPage("ShowHotels", params, false);
+ break;
+ case "ShowHotels":
+ case "SpecialOffers":
+ showPage("", null, false);
+ break;
+ }
+ };
+
+ export function updateSearchResults(): void {
+ var params = getCurrentQueryParams();
+ params["location"] = locationComboBox.GetValue();
+ params["minprice"] = nightyRateTrackBar.GetPositionStart();
+ params["maxprice"] = nightyRateTrackBar.GetPositionEnd();
+ params["custrating"] = customerRatingTrackBar.GetPosition();
+ params["ourrating"] = ourRatingCheckBoxList.GetSelectedValues().join(",");
+ showPage("ShowHotels", params);
+ };
+
+ export function onBookHotelButtonClick(hotelID: string): void {
+ var queryParams = getCurrentQueryParams();
+ queryParams["hotelID"] = hotelID;
+ showPage("ShowRooms", queryParams);
+ };
+
+ export function onDetailsHotelButtonClick(hotelID: string): void {
+ var queryParams = getCurrentQueryParams();
+ queryParams["hotelID"] = hotelID;
+ showPage("ShowDetails", queryParams);
+ };
+
+ export function onShowStartFilterButtonClick(s: ASPxClientButton, e: ASPxClientButtonClickEventArgs): void {
+ startFilterPopupControl.ShowAtElementByID("MainCallbackPanel_ContentPane");
+ };
+
+ export function onChangeStartFilterButtonClick(s: ASPxClientButton, e: ASPxClientButtonClickEventArgs): void {
+ if (ASPxClientEdit.ValidateGroup("DateEditors")) {
+ var params = getCurrentQueryParams();
+ params["checkin"] = getFormattedDate(checkInDateEdit.GetValue());
+ params["checkout"] = getFormattedDate(checkOutDateEdit.GetValue());
+ params["rooms"] = roomsNumberSpinEdit.GetValue() || 1;
+ params["adults"] = adultsNumberSpinEdit.GetValue() || 1;
+ params["children"] = childrenNumberSpinEdit.GetValue() || 0;
+ startFilterPopupControl.Hide();
+ showPage(hiddenField.Get("page").toString(), params);
+ }
+ };
+
+ export function onBookRoomButtonClick(roomID: string): void {
+ var params = getCurrentQueryParams();
+ params["roomID"] = roomID;
+ showPage("Booking", params);
+ };
+
+ export function onShowRoomsButtonClick(): void {
+ var queryParams = getCurrentQueryParams();
+ showPage("ShowRooms", queryParams);
+ };
+
+ export function onShowDetailsButtonClick(): void {
+ var queryParams = getCurrentQueryParams();
+ showPage("ShowDetails", queryParams);
+ };
+
+ export function onRoomImageNavItemClick(roomID: string, pictureName: string): void {
+ setTimeout(function () {
+ imagePopupControl.PerformCallback(roomID + "|" + pictureName);
+ imagePopupControl.ShowAtElementByID("MainCallbackPanel_ContentPane");
+ }, 500);
+ };
+
+ export function onRoomsNavBarExpandedChanged(s: ASPxClientNavBar, e: ASPxClientNavBarGroupEventArgs): void {
+ ASPxClientControl.AdjustControls(s.GetMainElement());
+ };
+
+ export function onNextBookingStepButtonClick(step: number): void {
+ var valid = true;
+ var validationGroup = "";
+ if (step == 1)
+ validationGroup = "Account";
+ if (step == 2)
+ validationGroup = "RoomDetails";
+ if (step == 3)
+ validationGroup = "PaymentDetails";
+
+ switch (step) {
+ case 1:
+ valid = ASPxClientEdit.ValidateEditorsInContainer(bookingPageControl.GetMainElement(), "Account");
+ if (valid) {
+ emailTextBox.SetValue(accountEmailTextBox.GetValue());
+ creditCardEmailTextBox.SetValue(accountEmailTextBox.GetValue());
+ showPage("Booking", getCurrentQueryParams());
+ return;
+ }
+ break;
+ case 2:
+ valid = ASPxClientEdit.ValidateEditorsInContainer(bookingPageControl.GetMainElement(), "RoomDetails");
+ emailTextBox.SetValue(accountEmailTextBox.GetValue());
+ break;
+ case 3:
+ var paymentType = paymentTypePageControl.GetActiveTabIndex();
+ if (paymentType == 0)
+ valid = ASPxClientEdit.ValidateEditorsInContainer(bookingPageControl.GetMainElement(), "CreditCard");
+ else if (paymentType == 1)
+ valid = ASPxClientEdit.ValidateEditorsInContainer(bookingPageControl.GetMainElement(), "Cash");
+ else if (paymentType == 2)
+ valid = ASPxClientEdit.ValidateEditorsInContainer(bookingPageControl.GetMainElement(), "PayPal");
+ break;
+ }
+ if (valid) {
+ bookingPageControl.GetTab(step).SetEnabled(true);
+ bookingPageControl.SetActiveTabIndex(step);
+ }
+ };
+
+ export function onAccountCaptchaHiddenFieldInit(s: ASPxClientHiddenField, e: ASPxClientEventArgs): void {
+ if (s.Get("IsCaptchaValid")) {
+ bookingPageControl.GetTab(1).SetEnabled(true);
+ bookingPageControl.SetActiveTabIndex(1);
+ }
+ };
+
+ export function onFinishBookingStepButtonClick(): void {
+ showAboutWindow();
+ };
+
+ export function OnPrintInvoiceButtonClick(): void {
+ showPage("PrintInvoice", getCurrentQueryParams());
+ };
+
+ export function onOfferClick(offerID: string): void {
+ offerFormPopup.SetContentHtml("");
+ offerFormPopup.PerformCallback(offerID);
+ var panel = ASPxClientControl.GetControlCollection().GetByName("DockPanel" + offerID);
+ var panelElement = panel.GetMainElement();
+ if (panelElement.offsetWidth < 330 || panelElement.offsetHeight < 250) {
+ offerFormPopup.SetWidth(400);
+ offerFormPopup.SetHeight(280);
+ offerFormPopup.ShowAtElementByID("SpecialOffersContainer");
+ }
+ else {
+ offerFormPopup.SetWidth(panelElement.offsetWidth);
+ offerFormPopup.SetHeight(panelElement.offsetHeight);
+ offerFormPopup.ShowAtElement(panelElement);
+ }
+ };
+
+ export function onSpecialOfferCheckButtonClick(hotelID: string, locationID: string): void {
+ if (ASPxClientEdit.ValidateGroup("DateEditors")) {
+ var queryParams: { [key: string]: any } = {
+ location: locationID,
+ hotelID: hotelID,
+ checkin: getFormattedDate(checkInDateEdit.GetValue()),
+ checkout: getFormattedDate(checkOutDateEdit.GetValue()),
+ rooms: roomsSpinEdit.GetValue() || 1,
+ adults: adultsSpinEdit.GetValue() || 1,
+ children: childrenSpinEdit.GetValue() || 0
+ };
+ showPage("ShowRooms", queryParams);
+ }
+ };
+
+ export function onIndexOfferClick(): void {
+ showPage("SpecialOffers", {});
+ };
+
+ export function onControlsInit(): void {
+ ASPxClientUtils.AttachEventToElement(window, 'popstate', onHistoryPopState);
+ var pathParts = document.location.href.split("/");
+ var url = pathParts[pathParts.length - 1];
+ try {
+ if (window.history)
+ window.history.replaceState(url, "");
+ } catch (e) { }
+ ASPxClientUtils.AttachEventToElement(window, "resize", onWindowResize);
+ if (ASPxClientUtils.iOSPlatform) {
+ // animate
+ }
+ };
+
+ export function updateRatingLabels(ratingControl: ASPxClientTrackBar) {
+ var start = ratingControl.GetPositionStart().toString();
+ var end = ratingControl.GetPositionEnd().toString();
+ document.getElementById("cpLeftLabelID").innerHTML = start + " " + end;
+ };
+
+ export function onRatingControlItemClick(s: ASPxClientRatingControl, e: ASPxClientRatingControlItemClickEventArgs): void {
+ hotelDetailsCallbackPanel.PerformCallback(s.GetValue().toString());
+ };
+
+ export function onInputKeyDown(s: ASPxClientTextBox, e: ASPxClientEditKeyEventArgs): void {
+ var keyCode = ASPxClientUtils.GetKeyCode(e.htmlEvent);
+ if (keyCode == 13)
+ (s.GetInputElement()).blur();
+ };
+
+ function getCurrentPage(): string {
+ var hfPage = hiddenField.Get("page");
+ if (hfPage)
+ return hfPage;
+ var pathParts = document.location.pathname.split("/");
+ return pathParts[pathParts.length - 1];
+ };
+
+ function showAboutWindow(): void {
+ aboutWindow.ShowAtElementByID("MainCallbackPanel_ContentPane");
+ };
+
+ function hideMenu(): void {
+ leftPanel.Collapse();
+ if (menuButton.GetMainElement() && menuButton.GetChecked())
+ menuButton.SetChecked(false);
+ };
+
+ function showMenu(): void {
+ leftPanel.Expand();
+ };
+
+ var _resizeSpecialOffersTimeoutID = -1;
+ function onWindowResize(): void {
+ switch (hiddenField.Get("page")) {
+ case "SpecialOffers":
+ if (_resizeSpecialOffersTimeoutID == -1)
+ _resizeSpecialOffersTimeoutID = setTimeout(resizeSpecialOffers, 200);
+ break;
+ }
+ hidePopups("AboutWindow", "StartFilterPopupControl", "LoginPopup", "OfferFormPopup", "ImagePopupControl");
+ };
+
+ function hidePopups(...names: string[]): void {
+ for (var i = 0; i < names.length; i++) {
+ var popupControl = ASPxClientControl.GetControlCollection().GetByName(names[i]);
+ popupControl.Hide();
+ }
+ };
+
+ function resizeSpecialOffers(): void {
+ for (var i = 1; i <= 4; i++) {
+ var panel = ASPxClientControl.GetControlCollection().GetByName("DockPanel" + i);
+ if (panel && panel.IsVisible()) {
+ var zone = panel.GetOwnerZone();
+ zone.SetWidth(((zone.GetMainElement()).parentNode).offsetWidth)
+ }
+ }
+ _resizeSpecialOffersTimeoutID = -1;
+ };
+
+ function getFormattedDate(date: Date): string {
+ return (date.getMonth() + 1) + "-" + date.getDate() + "-" + date.getFullYear();
+ };
+
+ function getCurrentQueryParams(): { [key:string]: any } {
+ var hfParams = hiddenField.Get("parameters");
+ if (hfParams)
+ return getParamsByQueryString(hfParams);
+ var query = document.location.search;
+ if (query[0] === "?")
+ query = query.substr(1);
+ return getParamsByQueryString(query);
+ };
+
+ function getQueryString(params: { [key:string]: any }): string {
+ var queryItems: any[] = [];
+ for (var key in params) {
+ if (!params.hasOwnProperty(key)) continue;
+ queryItems.push(key + "=" + params[key]);
+ }
+ if (queryItems.length > 0)
+ return queryItems.join("&");
+ return "";
+ };
+
+ function getParamsByQueryString(queryString: string): { [key: string]: string } {
+ var result: { [key: string]: any } = {};
+ if (queryString) {
+ var queryStringArray = queryString.split("&");
+ for (var i = 0; i < queryStringArray.length; i++) {
+ var part = queryStringArray[i].split('=');
+ if (part.length != 2) continue;
+ result[part[0]] = decodeURIComponent(part[1].replace(/\+/g, " "));
+ }
+ }
+ return result;
+ };
+
+ function onHistoryPopState(evt: any): void {
+ if (evt.state !== null && evt.state !== undefined) {
+ var uriParts = evt.state.split("?");
+ showPage(uriParts[0], getParamsByQueryString(uriParts[1]), true);
+ }
+ };
+}
\ No newline at end of file
diff --git a/types/devexpress-web/v171/index.d.ts b/types/devexpress-web/v171/index.d.ts
new file mode 100644
index 0000000000..50aac382b1
--- /dev/null
+++ b/types/devexpress-web/v171/index.d.ts
@@ -0,0 +1,33698 @@
+// Type definitions for DevExpress ASP.NET v171.4
+// Project: http://devexpress.com/
+// Definitions by: DevExpress Inc.
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
+
+/**
+ * A client-side counterpart of the DashboardViewer extension.
+ */
+interface MVCxClientDashboardViewer extends ASPxClientDashboardViewer {
+}
+/**
+ * Represents a list of records from the dashboard data source.
+ */
+interface ASPxClientDashboardItemUnderlyingData {
+ /**
+ * Gets the number of rows in the underlying data set.
+ */
+ GetRowCount(): number;
+ /**
+ * Returns the value of the specified cell within the underlying data set.
+ * @param rowIndex An integer value that specifies the zero-based index of the required row.
+ * @param dataMember A String that specifies the required data member.
+ */
+ GetRowValue(rowIndex: number, dataMember: string): Object;
+ /**
+ * Returns an array of data members available in a data source.
+ */
+ GetDataMembers(): string[];
+ /**
+ * Returns whether or not a request for underlying data was successful.
+ */
+ IsDataReceived(): boolean;
+ /**
+ * Returns a callstack containing the error caused by an unsuccessful request for underlying data.
+ */
+ GetRequestDataError(): string;
+}
+/**
+ * Contains parameters used to obtain the underlying data for the dashboard item.
+ */
+interface ASPxClientDashboardItemRequestUnderlyingDataParameters {
+ /**
+ * Gets or sets an array of data member identifiers used to obtain underlying data.
+ * Value: An array of string values that specify data member identifiers.
+ */
+ DataMembers: string[];
+ /**
+ * Gets or sets axis points used to obtain the underlying data.
+ * Value: An array of ASPxClientDashboardItemDataAxisPoint objects that represent axis points.
+ */
+ AxisPoints: ASPxClientDashboardItemDataAxisPoint[];
+ /**
+ * Gets or sets the dimension value used to obtain the underlying data.
+ * Value: The dimension value.
+ */
+ ValuesByAxisName: Object;
+ /**
+ * Gets or sets the unique dimension value used to obtain the underlying data.
+ * Value: The unique dimension value.
+ */
+ UniqueValuesByAxisName: Object;
+}
+/**
+ * References a method executed after an asynchronous request is complete.
+ */
+interface ASPxClientDashboardItemRequestUnderlyingDataCompleted {
+ /**
+ * References a method executed after an asynchronous request is completed.
+ * @param data An ASPxClientDashboardItemUnderlyingData object that represents a list of records from the dashboard data source.
+ */
+ (data: ASPxClientDashboardItemUnderlyingData): void;
+}
+/**
+ * References a method that will handle the ItemClick events.
+ */
+interface ASPxClientDashboardItemClickEventHandler {
+ /**
+ * References a method that will handle the ItemClick events.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardItemClickEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardItemClickEventArgs): void;
+}
+/**
+ * Provides data for the ItemClick events.
+ */
+interface ASPxClientDashboardItemClickEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the name of the dashboard item for which the event has been raised.
+ * Value: A string value that is the dashboard item name.
+ */
+ ItemName: string;
+ /**
+ * Gets the dashboard item's client data.
+ */
+ GetData(): ASPxClientDashboardItemData;
+ /**
+ * Returns the axis point corresponding to the clicked visual element.
+ * @param axisName A string value returned by the DashboardDataAxisNames class that specifies the name of the data axis.
+ */
+ GetAxisPoint(axisName: string): ASPxClientDashboardItemDataAxisPoint;
+ /**
+ * Gets measures corresponding to the clicked visual element.
+ */
+ GetMeasures(): ASPxClientDashboardItemDataMeasure[];
+ /**
+ * Gets deltas corresponding to the clicked visual element.
+ */
+ GetDeltas(): ASPxClientDashboardItemDataDelta[];
+ /**
+ * Gets the dimensions used to create a hierarchy of axis points for the specified axis.
+ * @param axisName A string value returned by the DashboardDataAxisNames class that specifies the name of the data axis.
+ */
+ GetDimensions(axisName: string): ASPxClientDashboardItemDataDimension[];
+ /**
+ * Requests underlying data corresponding to the clicked visual element.
+ * @param onCompleted A ASPxClientDashboardItemRequestUnderlyingDataCompleted object that references a method executed after the request is completed.
+ * @param dataMembers An array of string values that specify data members used to obtain underlying data.
+ */
+ RequestUnderlyingData(onCompleted: ASPxClientDashboardItemRequestUnderlyingDataCompleted, dataMembers: string[]): void;
+}
+/**
+ * References a method that will handle the ItemVisualInteractivity events.
+ */
+interface ASPxClientDashboardItemVisualInteractivityEventHandler {
+ /**
+ * References a method that will handle the ItemVisualInteractivity events.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardItemVisualInteractivityEventArgs object containing event data.
+ */
+ (source: S, e: ASPxClientDashboardItemVisualInteractivityEventArgs): void;
+}
+/**
+ * Provides data for the ItemVisualInteractivity events.
+ */
+interface ASPxClientDashboardItemVisualInteractivityEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the component name of the dashboard item for which the event was raised.
+ * Value: A string value that is the component name of the dashboard item.
+ */
+ ItemName: string;
+ /**
+ * Gets the selection mode for dashboard item elements.
+ */
+ GetSelectionMode(): string;
+ /**
+ * Sets the selection mode for dashboard item elements.
+ * @param selectionMode A String that specifies the selection mode.
+ */
+ SetSelectionMode(selectionMode: string): void;
+ /**
+ * Returns whether or not highlighting is enabled for the current dashboard item.
+ */
+ IsHighlightingEnabled(): boolean;
+ /**
+ * Enables highlighting for the current dashboard item.
+ * @param enableHighlighting true, to enable highlighting; otherwise, false.
+ */
+ EnableHighlighting(enableHighlighting: boolean): void;
+ /**
+ * Gets data axes used to perform custom interactivity actions.
+ */
+ GetTargetAxes(): string[];
+ /**
+ * Sets data axes used to perform custom interactivity actions.
+ * @param targetAxes An array of String objects that specify names of data axes.
+ */
+ SetTargetAxes(targetAxes: string[]): void;
+ /**
+ * Gets the default selection for the current dashboard item.
+ */
+ GetDefaultSelection(): ASPxClientDashboardItemDataAxisPointTuple[];
+ /**
+ * Sets the default selection for the current dashboard item.
+ * @param values An array of ASPxClientDashboardItemDataAxisPointTuple objects specifying axis point tuples used to select default elements.
+ */
+ SetDefaultSelection(values: ASPxClientDashboardItemDataAxisPointTuple[]): void;
+}
+/**
+ * References a method that will handle the ItemSelectionChanged events.
+ */
+interface ASPxClientDashboardItemSelectionChangedEventHandler {
+ /**
+ * References a method that will handle the ItemSelectionChanged events.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardItemSelectionChangedEventArgs object containing event data.
+ */
+ (source: S, e: ASPxClientDashboardItemSelectionChangedEventArgs): void;
+}
+/**
+ * Provides data for the ItemSelectionChanged events.
+ */
+interface ASPxClientDashboardItemSelectionChangedEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the component name of the dashboard item for which the event was raised.
+ * Value: A string that is the component name of the dashboard item.
+ */
+ ItemName: string;
+ /**
+ * Gets currently selected elements.
+ */
+ GetCurrentSelection(): ASPxClientDashboardItemDataAxisPointTuple[];
+}
+/**
+ * References a method that will handle the ItemElementCustomColor event.
+ */
+interface ASPxClientDashboardItemElementCustomColorEventHandler {
+ /**
+ * References a method that will handle the ItemElementCustomColor events.
+ * @param source The event source.
+ * @param e An ASPxClientDashboardItemElementCustomColorEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardItemElementCustomColorEventArgs): void;
+}
+/**
+ * Provides data for the ItemElementCustomColor events.
+ */
+interface ASPxClientDashboardItemElementCustomColorEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the component name of the dashboard item for which the event was raised.
+ * Value: A string value that is the component name of the dashboard item for which the event was raised.
+ */
+ ItemName: string;
+ /**
+ * Gets the axis point tuple that corresponds to the current dashboard item element.
+ */
+ GetTargetElement(): ASPxClientDashboardItemDataAxisPointTuple;
+ /**
+ * Gets the color of the current dashboard item element.
+ */
+ GetColor(): string;
+ /**
+ * Sets the color of the current dashboard item element.
+ * @param color A String that specifies the color of the current dashboard item element.
+ */
+ SetColor(color: string): void;
+ /**
+ * Gets measures corresponding to the current dashboard item element.
+ */
+ GetMeasures(): ASPxClientDashboardItemDataMeasure[];
+}
+/**
+ * References a method that will handle the ItemWidgetCreated events.
+ */
+interface ASPxClientDashboardItemWidgetCreatedEventHandler {
+ /**
+ * References a method that will handle the ItemWidgetCreated events.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardItemWidgetEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardItemWidgetEventArgs): void;
+}
+/**
+ * References a method that will handle the ItemWidgetUpdating event.
+ */
+interface ASPxClientDashboardItemWidgetUpdatingEventHandler {
+ /**
+ * References a method that will handle the ItemWidgetUpdating event.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardItemWidgetEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardItemWidgetEventArgs): void;
+}
+/**
+ * References a method that will handle the ItemWidgetUpdated event.
+ */
+interface ASPxClientDashboardItemWidgetUpdatedEventHandler {
+ /**
+ * References a method that will handle the ItemWidgetUpdated event.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardItemWidgetEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardItemWidgetEventArgs): void;
+}
+/**
+ * References a method that will handle the ItemBeforeWidgetDisposed events.
+ */
+interface ASPxClientDashboardItemBeforeWidgetDisposedEventHandler {
+ /**
+ * References a method that will handle the ItemBeforeWidgetDisposed events.
+ * @param source The event source.
+ * @param e A ASPxClientDashboardItemWidgetEventArgs object that contains event data.
+ */
+ (source: S, e: ASPxClientDashboardItemWidgetEventArgs): void;
+}
+/**
+ * Provides data for events related to client widgets used to visualize data in dashboard items.
+ */
+interface ASPxClientDashboardItemWidgetEventArgs extends ASPxClientEventArgs {
+ /**
+ * Gets the component name of the dashboard item for which the event was raised.
+ * Value: A string value that is the component name of the dashboard item.
+ */
+ ItemName: string;
+ /**
+ * Returns an underlying widget corresponding to the current dashboard item.
+ */
+ GetWidget(): Object;
+}
+/**
+ * Represents multidimensional data visualized in the dashboard item.
+ */
+interface ASPxClientDashboardItemData {
+ /**
+ * Gets the names of the axes that constitute the current ASPxClientDashboardItemData.
+ */
+ GetAxisNames(): string[];
+ /**
+ * Returns the specified data axis.
+ * @param axisName A string value returned by the DashboardDataAxisNames class that specifies the name of the data axis.
+ */
+ GetAxis(axisName: string): ASPxClientDashboardItemDataAxis;
+ /**
+ * Gets the dimensions used to create a hierarchy of axis points for the specified axis.
+ * @param axisName A string value returned by the DashboardDataAxisNames class that specifies the name of the data axis.
+ */
+ GetDimensions(axisName: string): ASPxClientDashboardItemDataDimension[];
+ /**
+ * Gets the measures for the current ASPxClientDashboardItemData object.
+ */
+ GetMeasures(): ASPxClientDashboardItemDataMeasure[];
+ /**
+ * Gets the deltas for the current ASPxClientDashboardItemData object.
+ */
+ GetDeltas(): ASPxClientDashboardItemDataDelta[];
+ /**
+ * Gets the slice of the current ASPxClientDashboardItemData object by the specified axis point tuple.
+ * @param tuple A ASPxClientDashboardItemDataAxisPointTuple object that is a tuple of axis points.
+ */
+ GetSlice(tuple: ASPxClientDashboardItemDataAxisPointTuple): ASPxClientDashboardItemData;
+ /**
+ * Gets the slice of the current ASPxClientDashboardItemData object by the specified axis point.
+ * @param axisPoint An ASPxClientDashboardItemDataAxisPoint object that is the data point in a multidimensional space.
+ */
+ GetSlice(axisPoint: ASPxClientDashboardItemDataAxisPoint): ASPxClientDashboardItemData;
+ /**
+ * Returns a total summary value for the specified measure.
+ * @param measureId A String that is the measure identifier.
+ */
+ GetMeasureValue(measureId: string): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Gets the summary value for the specified delta.
+ * @param deltaId A String that is the data item identifier.
+ */
+ GetDeltaValue(deltaId: string): ASPxClientDashboardItemDataDeltaValue;
+ /**
+ * Returns an array of data members available in a data source.
+ */
+ GetDataMembers(): string[];
+ /**
+ * Creates a tuple based on the specified axes names and corresponding values.
+ * @param values An array of name-value pairs containing the axis name and corresponding values.
+ */
+ CreateTuple(values: Object[]): ASPxClientDashboardItemDataAxisPointTuple;
+ /**
+ * Creates a tuple based on the specified axis points.
+ * @param axisPoints An array of ASPxClientDashboardItemDataAxisPoint objects that specify axis points belonging to different data axes.
+ */
+ CreateTuple(axisPoints: ASPxClientDashboardItemDataAxisPoint[]): ASPxClientDashboardItemDataAxisPointTuple;
+}
+/**
+ * An axis that contains data points corresponding to the specified value hierarchy.
+ */
+interface ASPxClientDashboardItemDataAxis {
+ /**
+ * Gets the dimensions used to create a hierarchy of axis points belonging to the current axis.
+ */
+ GetDimensions(): ASPxClientDashboardItemDataDimension[];
+ /**
+ * Gets the root axis point belonging to the current ASPxClientDashboardItemDataAxis.
+ */
+ GetRootPoint(): ASPxClientDashboardItemDataAxisPoint;
+ /**
+ * Returns axis points corresponding to values of the last-level dimension.
+ */
+ GetPoints(): ASPxClientDashboardItemDataAxisPoint[];
+ /**
+ * Returns axis points corresponding to the specified dimension.
+ * @param dimensionId A String that is the dimension identifier.
+ */
+ GetPointsByDimension(dimensionId: string): ASPxClientDashboardItemDataAxisPoint[];
+ /**
+ * Returns the data point for the specified axis by unique values.
+ * @param uniqueValues A hierarchy of unique values identifying the required data point.
+ */
+ GetPointByUniqueValues(uniqueValues: Object[]): ASPxClientDashboardItemDataAxisPoint;
+}
+/**
+ * Contains the dimension metadata.
+ */
+interface ASPxClientDashboardItemDataDimension {
+ /**
+ * Gets the dimension identifier.
+ * Value: A string value that is the dimension identifier.
+ */
+ Id: string;
+ /**
+ * Gets or sets the name of the dimension.
+ * Value: A string value that is the name of the dimension.
+ */
+ Name: string;
+ /**
+ * Gets the data member identifier for the current dimension.
+ * Value: A string value that identifies a data member.
+ */
+ DataMember: string;
+ /**
+ * Gets the group interval for date-time values for the current dimension.
+ * Value: A string value that represents how date-time values are grouped.
+ */
+ DateTimeGroupInterval: string;
+ /**
+ * Gets the group interval for string values.
+ * Value: A string value that specifies the group interval for string values.
+ */
+ TextGroupInterval: string;
+ /**
+ * Formats the specified value using format settings of the current dimension.
+ * @param value A value to be formatted.
+ */
+ Format(value: Object): string;
+}
+/**
+ * Contains the measure metadata.
+ */
+interface ASPxClientDashboardItemDataMeasure {
+ /**
+ * Gets the measure identifier.
+ * Value: A string value that is the measure identifier.
+ */
+ Id: string;
+ /**
+ * Gets the name of the measure.
+ * Value: A string value that is the name of the measure.
+ */
+ Name: string;
+ /**
+ * Gets the data member that identifies the data source list used to provide data for the current measure.
+ * Value: A string value that identifies the data source list used to provide data for the current measure.
+ */
+ DataMember: string;
+ /**
+ * Gets the type of summary function calculated against the current measure.
+ * Value: A string value that identifies the type of summary function calculated against the current measure.
+ */
+ SummaryType: string;
+ /**
+ * Formats the specified value using format settings of the current measure.
+ * @param value A value to be formatted.
+ */
+ Format(value: Object): string;
+}
+/**
+ * Contains the delta metadata.
+ */
+interface ASPxClientDashboardItemDataDelta {
+ /**
+ * Gets the data item identifier.
+ * Value: A string that is the data item identifier.
+ */
+ Id: string;
+ /**
+ * Gets the name of the data item container.
+ * Value: A string value that is the name of the data item container.
+ */
+ Name: string;
+ /**
+ * Gets the identifier for the measure that provides actual values.
+ * Value: A string value that is the measure identifier.
+ */
+ ActualMeasureId: string;
+ /**
+ * Gets the identifier for the measure that provides target values.
+ * Value: A string value that is the measure identifier.
+ */
+ TargetMeasureId: string;
+}
+/**
+ * Provides dimension values at the specified axis point.
+ */
+interface ASPxClientDashboardItemDataDimensionValue {
+ /**
+ * Gets the current dimension value.
+ */
+ GetValue(): Object;
+ /**
+ * Gets the unique value for the current dimension value.
+ */
+ GetUniqueValue(): Object;
+ /**
+ * Gets the display text for the current dimension value.
+ */
+ GetDisplayText(): string;
+}
+/**
+ * Provides the measure value and display text.
+ */
+interface ASPxClientDashboardItemDataMeasureValue {
+ /**
+ * Gets the measure value.
+ */
+ GetValue(): Object;
+ /**
+ * Gets the measure display text.
+ */
+ GetDisplayText(): string;
+}
+/**
+ * Provides delta element values.
+ */
+interface ASPxClientDashboardItemDataDeltaValue {
+ /**
+ * Provides access to the actual value displayed within the delta element.
+ */
+ GetActualValue(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Provides access to the target value.
+ */
+ GetTargetValue(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Provides access to the absolute difference between the actual and target values.
+ */
+ GetAbsoluteVariation(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Provides access to the percent of variation between the actual and target values.
+ */
+ GetPercentVariation(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Provides access to the percentage of the actual value in the target value.
+ */
+ GetPercentOfTarget(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Provides access to the main delta value.
+ */
+ GetDisplayValue(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Provides access to the first additional delta value.
+ */
+ GetDisplaySubValue1(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Provides access to the second additional delta value.
+ */
+ GetDisplaySubValue2(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Gets the value specifying the condition for displaying the delta indication.
+ */
+ GetIsGood(): ASPxClientDashboardItemDataMeasureValue;
+ /**
+ * Gets the type of delta indicator.
+ */
+ GetIndicatorType(): ASPxClientDashboardItemDataMeasureValue;
+}
+/**
+ * A point on the data axis.
+ */
+interface ASPxClientDashboardItemDataAxisPoint {
+ /**
+ * Gets the name of the axis to which the current axis point belongs.
+ */
+ GetAxisName(): string;
+ /**
+ * Gets the last level dimension corresponding to the current axis point.
+ */
+ GetDimension(): ASPxClientDashboardItemDataDimension;
+ /**
+ * Gets the collection of dimensions used to create a hierarchy of axis points from the root point to the current axis point.
+ */
+ GetDimensions(): ASPxClientDashboardItemDataDimension[];
+ /**
+ * Gets the value corresponding to the current axis point.
+ */
+ GetValue(): Object;
+ /**
+ * Gets the display text corresponding to the current axis point.
+ */
+ GetDisplayText(): string;
+ /**
+ * Gets the unique value corresponding to the current axis point.
+ */
+ GetUniqueValue(): Object;
+ /**
+ * Gets the dimension values at the specified axis point.
+ */
+ GetDimensionValue(): ASPxClientDashboardItemDataDimensionValue;
+ /**
+ * Gets the dimension value at the current axis point.
+ * @param dimensionId A String value that specifies the dimension identifier.
+ */
+ GetDimensionValue(dimensionId: string): ASPxClientDashboardItemDataDimensionValue;
+ /**
+ * Gets the child axis points for the current axis point.
+ */
+ GetChildren(): ASPxClientDashboardItemDataAxisPoint[];
+ /**
+ * Gets the parent axis point for the current axis point.
+ */
+ GetParent(): ASPxClientDashboardItemDataAxisPoint;
+}
+/**
+ * Represents a tuple of axis points.
+ */
+interface ASPxClientDashboardItemDataAxisPointTuple {
+ /**
+ * Returns the axis point belonging to the default data axis.
+ */
+ GetAxisPoint(): ASPxClientDashboardItemDataAxisPoint;
+ /**
+ * Returns the axis point belonging to the specified data axis.
+ * @param axisName A string value returned by the DashboardDataAxisNames class that specifies the name of the data axis.
+ */
+ GetAxisPoint(axisName: string): ASPxClientDashboardItemDataAxisPoint;
+}
+/**
+ * A range in the Range Filter dashboard item.
+ */
+interface ASPxClientDashboardRangeFilterSelection {
+ /**
+ * Gets or sets a maximum value in the range of the Range Filter dashboard item.
+ * Value: A maximum value in the range of the Range Filter dashboard item.
+ */
+ Maximum: Object;
+ /**
+ * Gets or sets a minimum value in the range of the Range Filter dashboard item.
+ * Value: A minimum value in the range of the Range Filter dashboard item.
+ */
+ Minimum: Object;
+}
+/**
+ * A collection of ASPxClientDashboardParameter objects.
+ */
+interface ASPxClientDashboardParameters {
+ /**
+ * Returns an array of dashboard parameters from the ASPxClientDashboardParameters collection.
+ */
+ GetParameterList(): ASPxClientDashboardParameter[];
+ /**
+ * Returns a dashboard parameter by its name.
+ * @param name A String object that specifies the parameter name.
+ */
+ GetParameterByName(name: string): ASPxClientDashboardParameter;
+ /**
+ * Returns a dashboard parameter by its index in the ASPxClientDashboardParameters collection.
+ * @param index An integer value that specifies the parameter index.
+ */
+ GetParameterByIndex(index: number): ASPxClientDashboardParameter;
+}
+/**
+ * A client-side dashboard parameter.
+ */
+interface ASPxClientDashboardParameter {
+ /**
+ * Gets the dashboard parameter name on the client side.
+ * Value: A string value that is the dashboard parameter name on the client side.
+ */
+ Name: string;
+ /**
+ * Gets the dashboard parameter value on the client side.
+ * Value: A string value that specifies the dashboard parameter value on the client side.
+ */
+ Value: Object;
+ /**
+ * Returns a parameter name.
+ */
+ GetName(): string;
+ /**
+ * Returns a current parameter value(s).
+ */
+ GetValue(): Object;
+ /**
+ * Specifies the current parameter value(s).
+ * @param value The current parameter value(s).
+ */
+ SetValue(value: Object): void;
+ /**
+ * Returns a default parameter value.
+ */
+ GetDefaultValue(): Object;
+ /**
+ * Returns the parameter's description displayed to an end-user.
+ */
+ GetDescription(): string;
+ /**
+ * Returns a parameter type.
+ */
+ GetType(): string;
+ /**
+ * Returns possible parameter values.
+ */
+ GetValues(): ASPxClientDashboardParameterValue[];
+}
+/**
+ * Provides access to the parameter value and display text.
+ */
+interface ASPxClientDashboardParameterValue {
+ /**
+ * Returns the parameter display text.
+ */
+ GetDisplayText(): string;
+ /**
+ * Returns a parameter value.
+ */
+ GetValue(): Object;
+}
+/**
+ * Contains settings that specify parameters affecting how the dashboard or dashboard item is exported in Image format.
+ */
+interface ImageFormatOptions {
+ /**
+ * Gets or sets an image format in which the dashboard (dashboard item) is exported.
+ * Value: A value returned by the DashboardExportImageFormat class that specifies an image format in which the dashboard (dashboard item) is exported.
+ */
+ Format: string;
+ /**
+ * Gets or sets the resolution (in dpi) used to export a dashboard (dashboard item) in Image format.
+ * Value: An integer value that specifies the resolution (in dpi) used to export a dashboard (dashboard item) in Image format.
+ */
+ Resolution: number;
+}
+/**
+ * Contains options which define how the dashboard item is exported to Excel format.
+ */
+interface ExcelFormatOptions {
+ /**
+ * Gets or sets the Excel format in which the dashboard item is exported.
+ * Value: A value returned by the DashboardExportExcelFormat class that specifies the Excel format in which the dashboard item is exported.
+ */
+ Format: string;
+ /**
+ * Gets or sets a character used to separate values in a CSV document.
+ * Value: A string value that specifies the character used to separate values in a CSV document.
+ */
+ CsvValueSeparator: string;
+}
+/**
+ * Contains settings that specify parameters affecting how the Grid dashboard item is exported.
+ */
+interface GridExportOptions {
+ /**
+ * Gets or sets whether the size of the Grid dashboard item is changed according to the width of the exported page.
+ * Value: true, to change the size of the Grid dashboard item according to the width of the exported page; otherwise, false.
+ */
+ FitToPageWidth: boolean;
+ /**
+ * Gets or sets whether to print column headers of the Grid dashboard item on every page.
+ * Value: true, to print column headers on every page; otherwise, false.
+ */
+ PrintHeadersOnEveryPage: boolean;
+}
+/**
+ * Contains settings that specify parameters affecting how the Pivot dashboard item is exported.
+ */
+interface PivotExportOptions {
+ /**
+ * Gets or sets whether to print the column headers of the Pivot dashboard item on every page.
+ * Value: true, to print column headers on every page; otherwise, false.
+ */
+ PrintHeadersOnEveryPage: boolean;
+}
+/**
+ * Contains settings that specify parameters affecting how the Pie dashboard item is exported.
+ */
+interface PieExportOptions {
+ /**
+ * Gets or sets whether dashboard item elements are arranged automatically on the exported page.
+ * Value: true, to arrange dashboard item elements automatically on the exported page; otherwise, false.
+ */
+ AutoArrangeContent: boolean;
+}
+/**
+ * Contains settings that specify parameters affecting how the Gauge dashboard item is exported.
+ */
+interface GaugeExportOptions {
+ /**
+ * Gets or sets whether dashboard item elements are arranged automatically on the exported page.
+ * Value: true, to arrange dashboard item elements automatically on the exported page; otherwise, false.
+ */
+ AutoArrangeContent: boolean;
+}
+/**
+ * Contains settings that specify parameters affecting how the Card dashboard item is exported.
+ */
+interface CardExportOptions {
+ /**
+ * Gets or sets whether dashboard item elements are arranged automatically on the exported page.
+ * Value: true, to arrange dashboard item elements automatically on the exported page; otherwise, false.
+ */
+ AutoArrangeContent: boolean;
+}
+/**
+ * Contains settings that specify parameters affecting how the Range Filter dashboard item is exported.
+ */
+interface RangeFilterExportOptions {
+ /**
+ * Gets or sets whether the page orientation used to export a Range Filter dashboard item is selected automatically.
+ * Value: true, to automatically select the page orientation used to export a Range Filter dashboard item; otherwise, false.
+ */
+ AutomaticPageLayout: boolean;
+ /**
+ * Gets or sets the export size mode for the Range Filter dashboard item.
+ * Value: A value returned by the RangeFilterExportSizeMode class that specifies the export size mode for the Range Filter dashboard item.
+ */
+ SizeMode: string;
+}
+/**
+ * Contains settings that specify parameters affecting how Chart dashboard items are exported.
+ */
+interface ChartExportOptions {
+ /**
+ * Gets or sets whether the page orientation used to export a Chart dashboard item is selected automatically.
+ * Value: true, to automatically select the page orientation used to export a Chart dashboard item; otherwise, false.
+ */
+ AutomaticPageLayout: boolean;
+ /**
+ * Gets or sets the export size mode for the Chart dashboard item.
+ * Value: A value returned by the ChartExportSizeMode class that specifies the export size mode for the Chart dashboard item.
+ */
+ SizeMode: string;
+}
+/**
+ * Contains settings that specify parameters affecting how Map dashboard items are exported.
+ */
+interface MapExportOptions {
+ /**
+ * Gets or sets whether the page orientation used to export a map dashboard item is selected automatically.
+ * Value: true, to automatically select the page orientation used to export a map dashboard item; otherwise, false.
+ */
+ AutomaticPageLayout: boolean;
+ /**
+ * Gets or sets the export size mode for the map dashboard item.
+ * Value: A value returned by the MapExportSizeMode class that specifies specifies the export size mode for the map dashboard item.
+ */
+ SizeMode: string;
+}
+/**
+ * Contains settings that specify parameters affecting how the dashboard (dashboard item) is exported.
+ */
+interface ASPxClientDashboardExportOptions {
+ /**
+ * Gets or sets the standard paper size.
+ * Value: A string value returned by the DashboardExportPaperKind class that specifies the standard paper size.
+ */
+ PaperKind: string;
+ /**
+ * Gets or sets the page orientation used to export a dashboard (dashboard item).
+ * Value: A string value returned by the DashboardExportPageLayout class that specifies the page orientation used to export a dashboard (dashboard item).
+ */
+ PageLayout: string;
+ /**
+ * Gets or sets the mode for scaling when exporting a dashboard (dashboard item).
+ * Value: A string value returned by the DashboardExportScaleMode class that specifies the mode for scaling when exporting a dashboard (dashboard item).
+ */
+ ScaleMode: string;
+ /**
+ * Gets or sets the scale factor (in fractions of 1) by which a dashboard (dashboard item) is scaled.
+ * Value: A Single value that specifies the scale factor by which a dashboard (dashboard item) is scaled.
+ */
+ ScaleFactor: number;
+ /**
+ * Gets or sets the number of horizontal/vertical pages spanning the total width/height of a dashboard (dashboard item).
+ * Value: An integer value that specifies the number of horizontal/vertical pages spanning the total width/height of a dashboard (dashboard item).
+ */
+ AutoFitPageCount: number;
+ /**
+ * Gets or sets the title of the exported document.
+ * Value: A string value that specifies the title of the exported document.
+ */
+ Title: string;
+ /**
+ * Gets or sets whether a dashboard title (or dashboard item's caption) is included as the exported document title.
+ * Value: A boolean value that specifies whether a dashboard title (or dashboard item's caption) is included as the exported document title.
+ */
+ ShowTitle: boolean;
+ /**
+ * Gets or sets the filter state's location on the exported document.
+ * Value: A string value returned by the DashboardExportFilterState class that specifies the filter state's location on the exported document.
+ */
+ FilterState: string;
+ /**
+ * Provides access to options for exporting a dashboard or individual items in Image format.
+ * Value: An ImageFormatOptions object containing settings that specify parameters affecting how the dashboard or dashboard item is exported in Image format.
+ */
+ ImageOptions: ImageFormatOptions;
+ /**
+ * Provides access to options for exporting individual dashboard items in Excel format.
+ * Value: An ExcelFormatOptions object containing settings that specify parameters affecting how the dashboard item is exported in Excel format.
+ */
+ ExcelOptions: ExcelFormatOptions;
+ /**
+ * Provides access to options for exporting a Grid dashboard item.
+ * Value: A GridExportOptions object containing settings that specify parameters that affect how Grid dashboard items are exported.
+ */
+ GridOptions: GridExportOptions;
+ /**
+ * Provides access to options for exporting a Pivot dashboard item.
+ * Value: A PivotExportOptions object containing settings that specify parameters that affect how Pivot dashboard items are exported.
+ */
+ PivotOptions: PivotExportOptions;
+ /**
+ * Provides access to options for exporting a Pie dashboard item.
+ * Value: A PieExportOptions object containing settings that specify parameters that affect how Pie dashboard items are exported.
+ */
+ PieOptions: PieExportOptions;
+ /**
+ * Provides access to options for exporting a Gauge dashboard item.
+ * Value: A GaugeExportOptions object containing settings that specify parameters that affect how Gauge dashboard items are exported.
+ */
+ GaugeOptions: GaugeExportOptions;
+ /**
+ * Provides access to options for exporting a Card dashboard item.
+ * Value: A CardExportOptions object containing settings that specify parameters that affect how Card dashboard items are exported.
+ */
+ CardOptions: CardExportOptions;
+ /**
+ * Provides access to options for exporting a Range Filter dashboard item.
+ * Value: A RangeFilterExportOptions object containing settings that specify parameters affecting how the Range Filter dashboard item is exported.
+ */
+ RangeFilterOptions: RangeFilterExportOptions;
+ /**
+ * Provides access to options for exporting a Chart dashboard item.
+ * Value: A ChartExportOptions object containing settings that specify parameters that affect how Chart dashboard items are exported.
+ */
+ ChartOptions: ChartExportOptions;
+ /**
+ * Provides access to options for exporting map dashboard items.
+ * Value: A MapExportOptions object containing settings that specify parameters that affect how map dashboard items are exported.
+ */
+ MapOptions: MapExportOptions;
+}
+/**
+ * Contains options related to exporting a dashboard/dashboard item to the PDF format.
+ */
+interface DashboardPdfExportOptions {
+ /**
+ * Gets or sets the type of paper for the exported document.
+ * Value: A DashboardExportPaperKind value that specifies the type of paper for the exported document.
+ */
+ PaperKind: string;
+ /**
+ * Gets or sets the page orientation used to export a dashboard/dashboard item.
+ * Value: A DashboardExportPageLayout value that specifies the page orientation used to export a dashboard/dashboard item.
+ */
+ PageLayout: string;
+ /**
+ * Gets or sets the mode for scaling a dashboard/dashboard item in the exported document.
+ * Value: A DashboardExportScaleMode value that specifies the mode for scaling a dashboard/dashboard item in the exported document.
+ */
+ ScaleMode: string;
+ /**
+ * Gets or sets the scale factor (in fractions of 1), by which a dashboard/dashboard item is scaled in the exported document.
+ * Value: A Single value that specifies the scale factor by which a dashboard/dashboard item is scaled in the exported document.
+ */
+ ScaleFactor: number;
+ /**
+ * Gets or sets the number of horizontal/vertical pages spanning the total width/height of a dashboard/dashboard item.
+ * Value: An integer value that specifies the number of horizontal/vertical pages spanning the total width/height of a dashboard/dashboard item.
+ */
+ AutoFitPageCount: number;
+ /**
+ * Gets or sets the title of the exported document.
+ * Value: A string value that specifies the title of the exported document.
+ */
+ Title: string;
+ /**
+ * Gets or sets whether a dashboard title (or dashboard item's caption) is included as the exported document title.
+ * Value: A boolean value that specifies whether a dashboard title (or dashboard item's caption) is included as the exported document title.
+ */
+ ShowTitle: boolean;
+ /**
+ * Gets or sets whether to add the state of master filter items to the exported document.
+ * Value: true, to add the state of master filter items to the exported document; otherwise, false.
+ */
+ ExportFilters: boolean;
+ /**
+ * Gets or sets whether to add current parameter values to the exported document.
+ * Value: true, to add current parameter values to the exported document; otherwise, false.
+ */
+ ExportParameters: boolean;
+ /**
+ * Gets or sets whether to add current values of a hidden parameter to the exported document.
+ * Value: true, to add current values of a hidden parameter to the exported document; otherwise, false.
+ */
+ IncludeHiddenParameters: boolean;
+ /**
+ * Gets or sets a position of the dashboard state (such as master filter or current parameter values) in the exported document.
+ * Value: A DashboardStateExportPosition object that specifies the position of the dashboard state in the exported document.
+ */
+ DashboardStatePosition: string;
+ /**
+ * Gets or sets whether cards within the Card dashboard item are arranged automatically on the exported page.
+ * Value: true, to arrange cards automatically on the exported page; otherwise, false.
+ */
+ CardAutoArrangeContent: boolean;
+ /**
+ * Gets or sets whether the page orientation used to export the Chart dashboard item is selected automatically.
+ * Value: true, to automatically select the page orientation used to export the Chart dashboard item; otherwise, false.
+ */
+ ChartAutomaticPageLayout: boolean;
+ /**
+ * Gets or sets the export size mode for the Chart dashboard item.
+ * Value: A ChartExportSizeMode value that specifies the export size mode for the Chart dashboard item.
+ */
+ ChartSizeMode: string;
+ /**
+ * Gets or sets whether gauges within the Gauge dashboard item are arranged automatically on the exported page.
+ * Value: true, to arrange gauges automatically on the exported page; otherwise, false.
+ */
+ GaugeAutoArrangeContent: boolean;
+ /**
+ * Gets or sets whether the size of the Grid dashboard item is changed according to the width of the exported page.
+ * Value: true, to change the size of the Grid dashboard item according to the width of the exported page; otherwise, false.
+ */
+ GridFitToPageWidth: boolean;
+ /**
+ * Gets or sets whether to add column headers of the Grid dashboard item to every page.
+ * Value: true, to add column headers to every page; otherwise, false.
+ */
+ GridPrintHeadersOnEveryPage: boolean;
+ /**
+ * Gets or sets whether the page orientation used to export the Map dashboard item is selected automatically.
+ * Value: true, to automatically select the page orientation used to export the Map dashboard item; otherwise, false.
+ */
+ MapAutomaticPageLayout: boolean;
+ /**
+ * Gets or sets the export size mode for the Map dashboard item.
+ * Value: A MapExportSizeMode value that specifies the export size mode for the Map dashboard item.
+ */
+ MapSizeMode: string;
+ /**
+ * Gets or sets whether pies within the Pie dashboard item are arranged automatically on the exported page.
+ * Value: true, to arrange pies automatically on the exported page; otherwise, false.
+ */
+ PieAutoArrangeContent: boolean;
+ /**
+ * Gets or sets whether to add column headers of the Pivot dashboard item to every page.
+ * Value: true, to add column headers to every page; otherwise, false.
+ */
+ PivotPrintHeadersOnEveryPage: boolean;
+ /**
+ * Gets or sets whether the page orientation used to export the Range Filter dashboard item is selected automatically.
+ * Value: true, to automatically select the page orientation used to export the Range Filter dashboard item; otherwise, false.
+ */
+ RangeFilterAutomaticPageLayout: boolean;
+ /**
+ * Gets or sets the export size mode for the Range Filter dashboard item.
+ * Value: A RangeFilterExportSizeMode value that specifies the export size mode for the Range Filter dashboard item.
+ */
+ RangeFilterSizeMode: string;
+ /**
+ * Gets or sets whether the page orientation used to export the Treemap dashboard item is selected automatically.
+ * Value: true, to automatically select the page orientation used to export the Treemap dashboard item; otherwise, false.
+ */
+ TreemapAutomaticPageLayout: boolean;
+ /**
+ * Gets or sets the export size mode for the Treemap dashboard item.
+ * Value: A TreemapExportSizeMode value that specifies the export size mode for the Treemap dashboard item.
+ */
+ TreemapSizeMode: string;
+}
+/**
+ * Contains options related to exporting a dashboard/dashboard item to an image.
+ */
+interface DashboardImageExportOptions {
+ /**
+ * Gets or sets a title of the exported document.
+ * Value: A string value that specifies the title of the exported document.
+ */
+ Title: string;
+ /**
+ * Gets or sets whether a dashboard title (or dashboard item's caption) is included as the exported document title.
+ * Value: true, to include a dashboard title (or dashboard item's caption) as the exported document title; otherwise, false.
+ */
+ ShowTitle: boolean;
+ /**
+ * Gets or sets whether to add the state of master filter items to the exported document.
+ * Value: true, to add the state of master filter items to the exported document; otherwise, false.
+ */
+ ExportFilters: boolean;
+ /**
+ * Gets or sets whether to add current parameter values to the exported document.
+ * Value: true, to add current parameter values to the exported document; otherwise, false.
+ */
+ ExportParameters: boolean;
+ /**
+ * Gets or sets whether to add current values of a hidden parameter to the exported document.
+ * Value: true, to add current values of a hidden parameter to the exported document; otherwise, false.
+ */
+ IncludeHiddenParameters: boolean;
+ /**
+ * Gets or sets an image format in which the dashboard/dashboard item is exported.
+ * Value: A DashboardExportImageFormat value that specifies an image format in which the dashboard/dashboard item is exported.
+ */
+ Format: string;
+ /**
+ * Gets or sets the resolution (in dpi) used to export a dashboard/dashboard item to an image.
+ * Value: An integer value that specifies the resolution (in dpi) used to export a dashboard/dashboard item to an image.
+ */
+ Resolution: number;
+ /**
+ * Gets or sets the scale factor (in fractions of 1), by which a dashboard/dashboard item is scaled in the exported document.
+ * Value: A string value that specifies the scale factor by which a dashboard/dashboard item is scaled in the exported document.
+ */
+ ScaleFactor: number;
+}
+/**
+ * Contains options related to exporting a dashboard/dashboard item to the Excel format.
+ */
+interface DashboardExcelExportOptions {
+ /**
+ * Gets or sets the Excel format in which the dashboard item is exported.
+ * Value: A DashboardExportExcelFormat value that specifies the Excel format in which the dashboard item is exported.
+ */
+ Format: string;
+ /**
+ * Gets or sets a character used to separate values in a CSV document.
+ * Value: A string value that specifies the character used to separate values in a CSV document.
+ */
+ CsvValueSeparator: string;
+ /**
+ * Gets or sets whether to add the state of master filter items to the exported document.
+ * Value: true, to add the state of master filter items to the exported document; otherwise, false.
+ */
+ ExportFilters: boolean;
+ /**
+ * Gets or sets whether to add current parameter values to the exported document.
+ * Value: true, to add current parameter values to the exported document; otherwise, false.
+ */
+ ExportParameters: boolean;
+ /**
+ * Gets or sets whether to add current values of a hidden parameter to the exported document.
+ * Value: true, to add current values of a hidden parameter to the exported document; otherwise, false.
+ */
+ IncludeHiddenParameters: boolean;
+ /**
+ * Gets or sets the position of the dashboard state (such as master filter or current parameter values) in the exported document.
+ * Value: A DashboardStateExcelExportPosition object that specifies the position of the dashboard state in the exported document.
+ */
+ DashboardStatePosition: string;
+}
+/**
+ * A client-side equivalent of the ASPxDashboard control.
+ */
+interface ASPxClientDashboard extends ASPxClientControl {
+ /**
+ * Fires when a round trip to the server has been initiated by a call to the client PerformDataCallback method.
+ */
+ CustomDataCallback: ASPxClientEvent>;
+ /**
+ * Occurs on the client side after a callback's server-side processing has been completed.
+ */
+ EndCallback: ASPxClientEvent>;
+ /**
+ * Occurs when a callback for server-side processing is initiated.
+ */
+ BeginCallback: ASPxClientEvent>;
+ /**
+ * Occurs after the state of the dashboard displayed in the ASPxClientDashboard is changed.
+ */
+ DashboardStateChanged: ASPxClientEvent>;
+ /**
+ * Occurs after a new dashboard is displayed in the ASPxClientDashboard.
+ */
+ DashboardChanged: ASPxClientEvent>;
+ /**
+ * For internal use.
+ */
+ CustomizeMenuItems: ASPxClientEvent>;
+ /**
+ * Occurs before any element in the Web Dashboard control has been rendered.
+ */
+ BeforeRender: ASPxClientEvent>;
+ /**
+ * Occurs when an end-user clicks a dashboard item.
+ */
+ ItemClick: ASPxClientEvent>;
+ /**
+ * Allows you to provide custom visual interactivity for data-bound dashboard items that support element selection and highlighting.
+ */
+ ItemVisualInteractivity: ASPxClientEvent>;
+ /**
+ * Allows you to access underlying UI/Data Visualization widgets.
+ */
+ ItemWidgetCreated: ASPxClientEvent>;
+ /**
+ * Allows you to access underlying UI/Data Visualization widgets.
+ */
+ ItemWidgetUpdating: ASPxClientEvent>;
+ /**
+ * Allows you to access underlying UI/Data Visualization widgets.
+ */
+ ItemWidgetUpdated: ASPxClientEvent>;
+ /**
+ * Allows you to access underlying UI/Data Visualization widgets.
+ */
+ ItemBeforeWidgetDisposed: ASPxClientEvent>;
+ /**
+ * Occurs after the selection within the dashboard item is changed.
+ */
+ ItemSelectionChanged: ASPxClientEvent