// Type definitions for DevExpress ASP.NET 191.6
// Project: https://devexpress.com/
// Definitions by: DevExpress Inc.
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
// TypeScript Version: 2.3
///
///
/**
* Represents the client ASPxGaugeControl.
*/
declare class ASPxClientGaugeControl extends ASPxClientControl {
/**
* Occurs when a callback for server-side processing is initiated.
*/
BeginCallback: ASPxClientEvent>;
/**
* Occurs on the client after a callback's server-side processing has been completed.
*/
EndCallback: ASPxClientEvent>;
/**
* Fires when errors have occurred during callback processing.
*/
CallbackError: ASPxClientEvent>;
/**
* Sends a callback to the server and generates the server-side ASPxGaugeControl.CustomCallback event, passing it the specified argument.
* @param parameter A string value that represents any information that needs to be sent to the server-side ASPxGaugeControl.CustomCallback event.
* @param onSuccess A client action to perform if the server round-trip completed successfully.
*/
PerformCallback(parameter: string, onSuccess?: (arg: string) => void): void;
/**
* Converts the specified object to the ASPxClientGaugeControl type. The converted client object specified by the obj parameter.
* @param obj The client object to be type cast.
*/
static Cast(obj: any): ASPxClientGaugeControl;
}
/**
* Contains style settings related to media elements in ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorCommandStyleSettings {
/**
* Gets or sets a media element's CSS class name.
*/
className: string;
/**
* Gets or sets an element's width.
*/
width: string;
/**
* Gets or sets an element's height.
*/
height: string;
/**
* Gets or sets a media element's border width.
*/
borderWidth: string;
/**
* Gets or sets a media element's border color.
*/
borderColor: string;
/**
* Gets or sets a media element's border style.
*/
borderStyle: string;
/**
* Gets or sets an element's top margin.
*/
marginTop: string;
/**
* Gets or sets an element's right margin.
*/
marginRight: string;
/**
* Gets or sets an element's bottom margin.
*/
marginBottom: string;
/**
* Gets or sets an element's left margin.
*/
marginLeft: string;
/**
* Gets or sets a media element's background color.
*/
backgroundColor: string;
/**
* Gets or sets the element's text alignment.
*/
textAlign: string;
/**
* Gets or sets the element's vertical alignment.
*/
verticalAlign: string;
}
/**
* The base class for parameters used in the ASPxHtmlEditor's client-side commands.
*/
declare class ASPxClientHtmlEditorCommandArguments {
constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement?: any);
/**
* Gets the currently selected element in the ASPxHtmlEditor.
*/
selectedElement: any;
}
/**
* Contains settings related to the ASPxClientCommandConsts.INSERTIMAGE_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorInsertImageCommandArguments extends ASPxClientHtmlEditorCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorInsertImageCommandArguments class.
* @param htmlEditor An HTML editor in which you want to insert an element.
* @param elementToReplace An object containing the currently selected element in the HTML editor. This element will be replaced with the inserted image.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, elementToReplace: any);
/**
* Specifies the source of the target image.
*/
src: string;
/**
* Creates an alternate text for the target image.
*/
alt: string;
/**
* Determines if the target image is wrapped with text.
*/
useFloat: boolean;
/**
* Determines the position of the target image.
*/
align: string;
/**
* Contains the style settings specifying the appearance of the target image.
*/
styleSettings: ASPxClientHtmlEditorCommandStyleSettings;
}
/**
* Contains settings related to the ASPxClientCommandConsts.CHANGEIMAGE_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorChangeImageCommandArguments extends ASPxClientHtmlEditorInsertImageCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorChangeImageCommandArguments class.
* @param htmlEditor The html editor in which the target element is located.
* @param selectedElement The image that is about to be changed.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
}
/**
* Contains settings related to the ASPxClientCommandConsts.INSERTLINK_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorInsertLinkCommandArguments extends ASPxClientHtmlEditorCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorInsertLinkCommandArguments class.
* @param htmlEditor An HTML editor in which you want to insert an element.
* @param selectedElement An object containing the currently selected element in the HTML editor. This element will be replaced with the inserted link.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
/**
* Specifies the url of the page the target link goes to.
*/
url: string;
/**
* Specifiies the text of the target link.
*/
text: string;
/**
* Determines where to open the target link.
*/
target: string;
/**
* Defines the title of the target link.
*/
title: string;
/**
* Contains the style settings defining the appearance of the target link element.
*/
styleSettings: ASPxClientHtmlEditorCommandStyleSettings;
}
/**
* The base class for parameters related to inserting or changing media elements in the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorChangeMediaElementCommandArguments extends ASPxClientHtmlEditorCommandArguments {
protected constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
/**
* Defines the HTML "id" attribute of the target media element.
*/
id: string;
/**
* Defines the source of the target media element.
*/
src: string;
/**
* Determines the position of the target media element.
*/
align: string;
/**
* Contains the style settings defining the appearance of the target media element.
*/
styleSettings: ASPxClientHtmlEditorCommandStyleSettings;
/**
* Returns the name of the client-side command corresponding to the parameter.
*/
GetCommandName(): string;
}
/**
* The base class for parameters related to inserting or changing HTML5 media elements (Audio and Video) in the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorChangeHtml5MediaElementCommandArguments extends ASPxClientHtmlEditorChangeMediaElementCommandArguments {
protected constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
/**
* Determines if a media file will start playing automatically.
*/
autoPlay: boolean;
/**
* Determines if a media file repeats indefinitely, or stops when it reaches the last frame.
*/
loop: boolean;
/**
* Determines if the media player controls should be displayed.
*/
showPlayerControls: boolean;
/**
* Determines how a media file should be loaded when the page loads.
*/
preloadMode: string;
}
/**
* Contains settings related to the ASPxClientCommandConsts.INSERTAUDIO_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorInsertAudioCommandArguments extends ASPxClientHtmlEditorChangeHtml5MediaElementCommandArguments {
constructor(htmlEditor: ASPxClientHtmlEditor, elementToReplace?: any);
}
/**
* Contains settings related to the ASPxClientCommandConsts.CHANGEAUDIO_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorChangeAudioCommandArguments extends ASPxClientHtmlEditorInsertAudioCommandArguments {
private constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
}
/**
* Contains settings related to the ASPxClientCommandConsts.INSERTVIDEO_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorInsertVideoCommandArguments extends ASPxClientHtmlEditorChangeHtml5MediaElementCommandArguments {
constructor(htmlEditor: ASPxClientHtmlEditor, elementToReplace?: any);
/**
* Defines the URL of an image that is shown while the video file is downloading, or until an end-user clicks the play button.
*/
posterUrl: string;
}
/**
* Contains settings related to the ASPxClientCommandConsts.CHANGEVIDEO_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorChangeVideoCommandArguments extends ASPxClientHtmlEditorInsertVideoCommandArguments {
private constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
}
/**
* Contains settings related to the ASPxClientCommandConsts.INSERTFLASH_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorInsertFlashCommandArguments extends ASPxClientHtmlEditorChangeMediaElementCommandArguments {
constructor(htmlEditor: ASPxClientHtmlEditor, elementToReplace?: any);
/**
* Determines if the target flash element will start playing automatically.
*/
autoPlay: boolean;
/**
* Defines if the target flash element repeats indefinitely, or stops when it reaches the last frame.
*/
loop: boolean;
/**
* Determines if the flash related items are displayed in the context menu of the target flash element.
*/
enableFlashMenu: boolean;
/**
* Determines if the target flash element can be displayed in the fullscreen mode.
*/
allowFullscreen: boolean;
/**
* Defines the rendering quality level used for the target flash element.
*/
quality: string;
}
/**
* Contains settings related to the ASPxClientCommandConsts.CHANGEFLASH_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorChangeFlashCommandArguments extends ASPxClientHtmlEditorInsertFlashCommandArguments {
private constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
}
/**
* Contains settings related to the ASPxClientCommandConsts.INSERTYOUTUBEVIDEO_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorInsertYouTubeVideoCommandArguments extends ASPxClientHtmlEditorChangeMediaElementCommandArguments {
constructor(htmlEditor: ASPxClientHtmlEditor, elementToReplace?: any);
/**
* Determines if suggested videos are shown after the target YouTube video finishes.
*/
showRelatedVideos: boolean;
/**
* Determines if the target YouTube video title and player actions (Watch later, Share) are shown.
*/
showVideoInfo: boolean;
/**
* Determines if the privacy-enhanced mode is enabled for the target YouTube video.
*/
enablePrivacyEnhancedMode: boolean;
/**
* Determines if the player controls are displayed for the target YouTube video.
*/
showPlayerControls: boolean;
/**
* Determines if the target YouTube video can be displayed in fullscreen mode.
*/
allowFullscreen: boolean;
}
/**
* Contains settings related to the ASPxClientCommandConsts.CHANGEYOUTUBEVIDEO_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorChangeYouTubeVideoCommandArguments extends ASPxClientHtmlEditorInsertYouTubeVideoCommandArguments {
private constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
}
/**
* Contains settings related to the ASPxClientCommandConsts.TABLEPROPERTIES_DIALOG_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorTablePropertiesCommandArguments extends ASPxClientHtmlEditorCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorTablePropertiesCommandArguments class with specified settings.
* @param htmlEditor The HTML editor executing a command.
* @param selectedElement An object containing the currently selected element in the HTML editor.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
/**
* Contains the style settings defining the appearance of the target table element.
*/
styleSettings: ASPxClientHtmlEditorCommandStyleSettings;
/**
* Determines the position of the target table element.
*/
align: string;
/**
* Gets or sets a table cell padding.
*/
cellPadding: number;
/**
* Gets or sets the table cell spacing.
*/
cellSpacing: number;
/**
* Gets or sets a value that is the table caption.
*/
caption: string;
/**
* Gets or sets a value indicating whether the first row/column serves as the table's header.
*/
headers: string;
/**
* Gets or sets the table's summary.
*/
summary: string;
}
/**
* Contains settings related to the ASPxClientCommandConsts.INSERTTABLE_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorInsertTableCommandArguments extends ASPxClientHtmlEditorTablePropertiesCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorInsertTableCommandArguments class with specified settings.
* @param htmlEditor The HTML editor executing a command.
* @param elementToReplace The element that will be replaced by the inserted table element.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, elementToReplace: any);
/**
* Gets or sets the count of columns in the table.
*/
columns: number;
/**
* Gets or sets the count of rows in the table.
*/
rows: number;
/**
* Gets or sets a value indicating whether all table columns should have equal width.
*/
isEqualColumnWidth: boolean;
}
/**
* Contains settings related to the ASPxClientCommandConsts.TABLECELLPROPERTIES_DIALOG_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorTableCellPropertiesCommandArguments extends ASPxClientHtmlEditorCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorTableCellPropertiesCommandArguments class with specified settings.
* @param htmlEditor The HTML editor executing a command.
* @param selectedElement An object containing the currently selected element in the HTML editor.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
/**
* Contains the style settings defining the appearance of the target cell element.
*/
styleSettings: ASPxClientHtmlEditorCommandStyleSettings;
/**
* Gets or sets a value that indicates whether the cell settings should be applied to all cells in the table.
*/
applyForAll: boolean;
}
/**
* Contains settings related to the ASPxClientCommandConsts.TABLEROWPROPERTIES_DIALOG_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorTableRowPropertiesCommandArguments extends ASPxClientHtmlEditorCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorTableRowPropertiesCommandArguments class with specified settings.
* @param htmlEditor The html editor in which the target element is located.
* @param selectedElement The element currently selected in the HTML editor.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
/**
* Contains the style settings specifying the appearance of the specified table row.
*/
styleSettings: ASPxClientHtmlEditorCommandStyleSettings;
}
/**
* Contains settings related to the ASPxClientCommandConsts.TABLECOLUMNPROPERTIES_DIALOG_COMMAND command parameter.
*/
declare class ASPxClientHtmlEditorTableColumnPropertiesCommandArguments extends ASPxClientHtmlEditorCommandArguments {
/**
* Initializes a new instance of the ASPxClientHtmlEditorTableColumnPropertiesCommandArguments class with specified settings.
* @param htmlEditor The HTML editor executing a command.
* @param selectedElement An object containing the currently selected element in the HTML editor.
*/
constructor(htmlEditor: ASPxClientHtmlEditor, selectedElement: any);
/**
* Contains the style settings defining the appearance of the target column element.
*/
styleSettings: ASPxClientHtmlEditorCommandStyleSettings;
}
/**
* Declares client constants that contain the names of the ASPxHtmlEditor's default client commands.
*/
declare class ASPxClientCommandConsts {
/**
* Identifies a command that shows a search panel.
*/
static SHOWSEARCHPANEL_COMMAND: string;
/**
* Identifies a command that invokes the Find and Replace dialog.
*/
static FINDANDREPLACE_DIALOG_COMMAND: string;
/**
* Identifies a command that applies the bold text formatting to the selected text. If it's already applied, cancels it.
*/
static BOLD_COMMAND: string;
/**
* Identifies a command that makes the selected text italic or regular type depending on the current state.
*/
static ITALIC_COMMAND: string;
/**
* Identifies a command that applies the underline text formatting to the selected text. If it's already applied, cancels it.
*/
static UNDERLINE_COMMAND: string;
/**
* Identifies a command that applies the strike through text formatting to the selected text. If it's already applied, cancels it.
*/
static STRIKETHROUGH_COMMAND: string;
/**
* Identifies a command that applies the superscript text formatting to the selected text. If it's already applied, cancels it.
*/
static SUPERSCRIPT_COMMAND: string;
/**
* Identifies a command that applies the subscript text formatting to the selected text. If it's already applied, cancels it.
*/
static SUBSCRIPT_COMMAND: string;
/**
* Identifies a command that centers the content of the currently focused paragraph.
*/
static JUSTIFYCENTER_COMMAND: string;
/**
* Identifies a command that left justifies the content of the currently focused paragraph.
*/
static JUSTIFYLEFT_COMMAND: string;
/**
* Identifies a command that creates an indent for the selected paragarph.
*/
static INDENT_COMMAND: string;
/**
* Identifies a command that creates an outdent for the focused paragarph.
*/
static OUTDENT_COMMAND: string;
/**
* Identifies a command that right justifies the content of the currently focused paragraph.
*/
static JUSTIFYRIGHT_COMMAND: string;
/**
* Identifies a command that fully justifies the content of the currently focused paragraph (aligned with both the left and right margines).
*/
static JUSTIFYFULL_COMMAND: string;
/**
* Identifies a command that changes the size of the selected text.
*/
static FONTSIZE_COMMAND: string;
/**
* Identifies a command that changes the font of the selected text.
*/
static FONTNAME_COMMAND: string;
/**
* Identifies a command that changes the color of a fore color pickers and sets the selected text fore color.
*/
static FONTCOLOR_COMMAND: string;
/**
* Identifies a command that changes the color of a back color pickers and sets the selected text back color.
*/
static BACKCOLOR_COMMAND: string;
/**
* Identifies a command that wraps the selected paragraph in the specified html tag.
*/
static FORMATBLOCK_COMMAND: string;
/**
* Identifies a command that wraps the currently selected text content in a specific html tag with a css class assigned to it.
*/
static APPLYCSS_COMMAND: string;
/**
* Identifies a command that removes all formatting from the selected content.
*/
static REMOVEFORMAT_COMMAND: string;
/**
* Identifies a command that cancels the last action.
*/
static UNDO_COMMAND: string;
/**
* Identifies a command that returns a previously canceled action.
*/
static REDO_COMMAND: string;
/**
* Identifies a command that copies the selected content.
*/
static COPY_COMMAND: string;
/**
* Identifies a command that pastes the content of the clipboard at the current cursor position.
*/
static PASTE_COMMAND: string;
/**
* Identifies a command that pastes a specified content taking into account that it was copied from Word.
*/
static PASTEFROMWORD_COMMAND: string;
/**
* Identifies a command that invokes the Paste from Word dialog.
*/
static PASTEFROMWORDDIALOG_COMMAND: string;
/**
* Identifies a command that cuts the selected content.
*/
static CUT_COMMAND: string;
/**
* Identifies a command that selects all content inside the html editor.
*/
static SELECT_ALL: string;
/**
* Identifies a command that deletes the selected content.
*/
static DELETE_COMMAND: string;
/**
* Identifies a command that can be used to correctly insert HTML code into the editor.
*/
static PASTEHTML_COMMAND: string;
/**
* Identifies a command that inserts a new ordered list.
*/
static INSERTORDEREDLIST_COMMAND: string;
/**
* Identifies a command that inserts a new unordered list.
*/
static INSERTUNORDEREDLIST_COMMAND: string;
/**
* Identifies a command that restarts the current ordered list.
*/
static RESTARTORDEREDLIST_COMMAND: string;
/**
* Identifies a command that continues a disrupted ordered list.
*/
static CONTINUEORDEREDLIST_COMMAND: string;
/**
* Identifies a command that removes a hyperlink from the selected text or image.
*/
static UNLINK_COMMAND: string;
/**
* Identifies a command that inserts a new hyperlink.
*/
static INSERTLINK_COMMAND: string;
/**
* Identifies a command that inserts a new image.
*/
static INSERTIMAGE_COMMAND: string;
/**
* Identifies a command that changes the selected image.
*/
static CHANGEIMAGE_COMMAND: string;
/**
* Identifies a command that initiates spell checking.
*/
static CHECKSPELLING_COMMAND: string;
/**
* Identifies a command that invokes the Insert Image dialog.
*/
static INSERTIMAGE_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Change Image dialog.
*/
static CHANGEIMAGE_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Insert Link dialog.
*/
static INSERTLINK_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Change Link dialog.
*/
static CHANGELINK_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Insert Table dialog.
*/
static INSERTTABLE_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Table Properties dialog.
*/
static TABLEPROPERTIES_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Cell Properties dialog.
*/
static TABLECELLPROPERTIES_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Column Properties dialog.
*/
static TABLECOLUMNPROPERTIES_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Row Properties dialog.
*/
static TABLEROWPROPERTIES_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes a default browser Print dialog, allowing an end-user to print the content of the html editor.
*/
static PRINT_COMMAND: string;
/**
* Identifies a command that toggles the full-screen mode.
*/
static FULLSCREEN_COMMAND: string;
/**
* Identifies a command that inserts a new table.
*/
static INSERTTABLE_COMMAND: string;
/**
* Identifies a command that changes the selected table.
*/
static CHANGETABLE_COMMAND: string;
/**
* Identifies a command that changes the selected table cell.
*/
static CHANGETABLECELL_COMMAND: string;
/**
* Identifies a command that changes the selected table row.
*/
static CHANGETABLEROW_COMMAND: string;
/**
* Identifies a command that changes the selected table column.
*/
static CHANGETABLECOLUMN_COMMAND: string;
/**
* Identifies a command that deletes the currently selected table.
*/
static DELETETABLE_COMMAND: string;
/**
* Identifies a command that deletes the currently selected table row.
*/
static DELETETABLEROW_COMMAND: string;
/**
* Identifies a command that deletes the currently selected table column.
*/
static DELETETABLECOLUMN_COMMAND: string;
/**
* Identifies a command that inserts a new column to the left from the currently focused one.
*/
static INSERTTABLECOLUMNTOLEFT_COMMAND: string;
/**
* Identifies a command that inserts a new column to the right from the currently focused one.
*/
static INSERTTABLECOLUMNTORIGHT_COMMAND: string;
/**
* Identifies a command that inserts a new row below the currently focused one.
*/
static INSERTTABLEROWBELOW_COMMAND: string;
/**
* Identifies a command that inserts a new row above the currently focused one.
*/
static INSERTTABLEROWABOVE_COMMAND: string;
/**
* Identifies a command that splits the current table cell horizontally.
*/
static SPLITTABLECELLHORIZONTALLY_COMMAND: string;
/**
* Identifies a command that splits the current table cell vertically.
*/
static SPLITTABLECELLVERTICALLY_COMMAND: string;
/**
* Identifies a command that merges the focused table cell with the one to the right.
*/
static MERGETABLECELLRIGHT_COMMAND: string;
/**
* Identifies a command that merges the focused table cell with the one below.
*/
static MERGETABLECELLDOWN_COMMAND: string;
/**
* Identifies a command that invokes a custom dialog.
*/
static CUSTOMDIALOG_COMMAND: string;
/**
* Identifies a command that exports the html editor content.
*/
static EXPORT_COMMAND: string;
/**
* Identifies a command that inserts a new audio element.
*/
static INSERTAUDIO_COMMAND: string;
/**
* Identifies a command that inserts a new video.
*/
static INSERTVIDEO_COMMAND: string;
/**
* Identifies a command that inserts a new flash element.
*/
static INSERTFLASH_COMMAND: string;
/**
* Identifies a command that inserts a new YouTube video.
*/
static INSERTYOUTUBEVIDEO_COMMAND: string;
/**
* Identifies a command that changes the selected audio element.
*/
static CHANGEAUDIO_COMMAND: string;
/**
* Identifies a command that changes the selected video element.
*/
static CHANGEVIDEO_COMMAND: string;
/**
* Identifies a command that changes the selected flash element.
*/
static CHANGEFLASH_COMMAND: string;
/**
* Identifies a command that changes the selected YouTube video element.
*/
static CHANGEYOUTUBEVIDEO_COMMAND: string;
/**
* Identifies a command that invokes the Insert Audio dialog.
*/
static INSERTAUDIO_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Insert Video dialog.
*/
static INSERTVIDEO_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Insert Flash dialog.
*/
static INSERTFLASH_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Insert YouTube Video dialog.
*/
static INSERTYOUTUBEVIDEO_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Change Audio dialog.
*/
static CHANGEAUDIO_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Change Video dialog.
*/
static CHANGEVIDEO_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Change Flash dialog.
*/
static CHANGEFLASH_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Change YouTube Video dialog.
*/
static CHANGEYOUTUBEVIDEO_DIALOG_COMMAND: string;
/**
* Identifies a command that pastes the content of the clipboard to the current cursor position, taking into account that the ASPxHtmlEditorHtmlEditingSettings.PasteMode property is set to SourceFormatting.
*/
static PASTEHTMLSOURCEFORMATTING_COMMAND: string;
/**
* Identifies a command that pastes the content of the clipboard to the current cursor position, taking into account that the ASPxHtmlEditorHtmlEditingSettings.PasteMode property is set to PlainText.
*/
static PASTEHTMLPLAINTEXT_COMMAND: string;
/**
* Identifies a command that pastes the content of the clipboard to the current cursor position, taking into account that the ASPxHtmlEditorHtmlEditingSettings.PasteMode property is set to MergeFormatting.
*/
static PASTEHTMLMERGEFORMATTING_COMMAND: string;
/**
* Identifies a command that inserts a new placeholder.
*/
static INSERTPLACEHOLDER_COMMAND: string;
/**
* Identifies a command that changes the selected placeholder.
*/
static CHANGEPLACEHOLDER_COMMAND: string;
/**
* Identifies a command that invokes the Insert Placeholder dialog.
*/
static INSERTPLACEHOLDER_DIALOG_COMMAND: string;
/**
* Identifies a command that invokes the Change Placeholder dialog.
*/
static CHANGEPLACEHOLDER_DIALOG_COMMAND: string;
/**
* Identifies a command that updates the editor content.
*/
static UPDATEDOCUMENT_COMMAND: string;
/**
* Identifies a command that changes properties of the element selected in the tag inspector.
*/
static CHANGEELEMENTPROPERTIES_COMMAND: string;
/**
* Identifies a command that invokes the Change Element Properties dialog.
*/
static CHANGEELEMENTPROPERTIES_DIALOG_COMMAND: string;
/**
* Identifies a command that comments the selected HTML code. If no code is selected, it comments the focused tag.
*/
static COMMENT_COMMAND: string;
/**
* Identifies a command that uncomments the selected HTML code. If no code is selected, the command uncomments the currently focused tag.
*/
static UNCOMMENTHTML_COMMAND: string;
/**
* Identifies a command that formats the current HTML document.
*/
static FORMATDOCUMENT_COMMAND: string;
/**
* Identifies a command that applies the indent formatting to the selected content.
*/
static INDENTLINE_COMMAND: string;
/**
* Identifies a command that applies the outdent formatting to the focused content.
*/
static OUTDENTLINE_COMMAND: string;
/**
* Identifies a command that collapses the selected HTML tag.
*/
static COLLAPSETAG_COMMAND: string;
/**
* Identifies a command that expands the selected HTML tag.
*/
static EXPANDTAG_COMMAND: string;
/**
* Identifies a command that shows intellisense for the HTML code editor.
*/
static SHOWINTELLISENSE_COMMAND: string;
}
/**
* A method that will handle the client ASPxClientHtmlEditor.DialogInitialized event.
* @param source An object representing the event's source.
* @param e An ASPxClientHtmlEditorDialogInitializedEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorDialogInitializedEventHandler { (source: Sender, e: ASPxClientHtmlEditorDialogInitializedEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.DialogInitialized client event.
*/
declare class ASPxClientHtmlEditorDialogInitializedEventArgs extends ASPxClientEventArgs {
/**
* Gets the name of the dialog that has been initialized.
*/
dialogName: string;
/**
* Gets a dialog object related to the event.
*/
dialog: ASPxClientHtmlEditorDialogBase;
}
/**
* Provides data for the event that fires when the HTML Editor dialogs are closed or are going to be closed.
*/
declare class ASPxClientHtmlEditorDialogCloseEventArgs extends ASPxClientEventArgs {
/**
* Gets the dialog name related to the event.
*/
dialogName: string;
/**
* Gets the dialog object related to the event.
*/
dialog: ASPxClientHtmlEditorDialogBase;
/**
* Gets a string that contains specific information (if any) passed from the client side for server-side processing.
*/
parameter: any;
}
/**
* A method that will handle the ASPxClientHtmlEditor.DialogClosing event.
* @param source The event source.
* @param e An ASPxClientHtmlEditorDialogClosingEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorDialogClosingEventHandler { (source: Sender, e: ASPxClientHtmlEditorDialogClosingEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.DialogClosing event.
*/
declare class ASPxClientHtmlEditorDialogClosingEventArgs extends ASPxClientHtmlEditorDialogCloseEventArgs {
/**
* Gets or sets a value indicating whether the action which raised the event should be canceled.
*/
cancel: boolean;
}
/**
* A method that will handle the ASPxClientHtmlEditor.DialogClosed event.
* @param source The event source.
* @param e An ASPxClientHtmlEditorDialogClosedEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorDialogClosedEventHandler { (source: Sender, e: ASPxClientHtmlEditorDialogClosedEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.DialogClosed event.
*/
declare class ASPxClientHtmlEditorDialogClosedEventArgs extends ASPxClientHtmlEditorDialogCloseEventArgs {
}
/**
* A method that will handle the client ASPxClientHtmlEditor.CommandExecuted event.
* @param source The event's source.
* @param e An ASPxClientHtmlEditorCommandExecutingEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorCommandExecutingEventHandler { (source: Sender, e: ASPxClientHtmlEditorCommandExecutingEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.CommandExecuting event.
*/
declare class ASPxClientHtmlEditorCommandExecutingEventArgs extends ASPxClientCancelEventArgs {
/**
* Initializes a new instance of the ASPxClientHtmlEditorCommandExecutingEventArgs object with the specified settings.
* @param commandName A string value that identifies the command currently being executed. Initializes the ASPxClientHtmlEditorCommandExecutingEventArgs.commandName property.
* @param parameter An object that contains the command specific information needed for handling the command execution. Initializes the ASPxClientHtmlEditorCommandExecutingEventArgs.parameter property.
*/
constructor(commandName: string, parameter: any);
/**
* Gets the name of the processed command.
*/
commandName: string;
/**
* Gets an optional parameter that complements the processed command.
*/
parameter: any;
}
/**
* A method that will handle the corresponding client event.
* @param source The event source. This parameter identifies the editor which raised the event.
* @param e An ASPxClientHtmlEditorCommandEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorCommandEventHandler { (source: Sender, e: ASPxClientHtmlEditorCommandEventArgs): void; }
/**
* Provides data for client events that relate to command processing (ASPxClientHtmlEditor.CommandExecuted, ASPxClientHtmlEditor.CustomCommand).
*/
declare class ASPxClientHtmlEditorCommandEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientHtmlEditorCommandEventArgs object with the specified settings. For internal use only.
* @param commandName A string value that identifies the executed command. Initializes the ASPxClientHtmlEditorCommandEventArgs.commandName property.
* @param parameter An object that can contain a command specific infomation needed for handling of the command execution. Initializes the ASPxClientHtmlEditorCommandEventArgs.parameter property.
*/
constructor(commandName: string, parameter: any);
/**
* Gets the name of the processed command.
*/
commandName: string;
/**
* Gets an optional parameter that complements the processed command.
*/
parameter: any;
}
/**
* A method that will handle the client ASPxClientHtmlEditor.CustomDialogOpened event.
* @param source An object representing the event's source.
* @param e An ASPxClientHtmlEditorCustomDialogEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorCustomDialogEventHandler { (source: Sender, e: ASPxClientHtmlEditorCustomDialogEventArgs): void; }
/**
* Provides data for client events that relate to custom dialog operations.
*/
declare class ASPxClientHtmlEditorCustomDialogEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientHtmlEditorCustomDialogEventArgs class.
* @param name A string value that specifies the custom dialog's name. Initializes the ASPxClientHtmlEditorCustomDialogEventArgs.name property.
*/
constructor(name: string);
/**
* Gets the name that uniquely identifies the processed custom dialog.
*/
name: string;
}
/**
* Provides data for client events that relate to closing a custom dialog.
*/
declare class ASPxClientHtmlEditorCustomDialogCloseEventArgsBase extends ASPxClientHtmlEditorCustomDialogEventArgs {
/**
* Initializes a new instance of the ASPxClientHtmlEditorCustomDialogCloseEventArgsBase class with the specified settings.
* @param name A string value that specifies the custom dialog's name. This value is assigned to the ASPxClientHtmlEditorCustomDialogEventArgs.name property.
* @param status An object that specifies a status that is returned to the parent control when the custom dialog is closed. This value is assigned to the ASPxClientHtmlEditorCustomDialogCloseEventArgsBase.status property.
*/
constructor(name: string, status: any);
/**
* Gets the status of the closed custom dialog.
*/
status: any;
}
/**
* A method that will handle the client ASPxClientHtmlEditor.CustomDialogClosing event.
* @param source An object representing the event's source.
* @param e An ASPxClientHtmlEditorCustomDialogClosingEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorCustomDialogClosingEventHandler { (source: Sender, e: ASPxClientHtmlEditorCustomDialogClosingEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.CustomDialogClosing client event.
*/
declare class ASPxClientHtmlEditorCustomDialogClosingEventArgs extends ASPxClientHtmlEditorCustomDialogCloseEventArgsBase {
/**
* Initializes a new instance of the ASPxClientHtmlEditorCustomDialogClosingEventArgs class with the specified settings.
* @param name A string value that specifies the custom dialog's name. This value is assigned to the ASPxClientHtmlEditorCustomDialogEventArgs.name property.
* @param status An object that specifies a status that is returned to the parent control when the custom dialog is closed. This value is assigned to the ASPxClientHtmlEditorCustomDialogCloseEventArgsBase.status property.
*/
constructor(name: string, status: any);
/**
* Gets or sets a value specifying whether the event was handled.
*/
handled: boolean;
}
/**
* A method that will handle the client ASPxClientHtmlEditor.CustomDialogClosed event.
* @param source An object representing the event's source.
* @param e An ASPxClientHtmlEditorCustomDialogClosedEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorCustomDialogClosedEventHandler { (source: Sender, e: ASPxClientHtmlEditorCustomDialogClosedEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.CustomDialogClosed client event.
*/
declare class ASPxClientHtmlEditorCustomDialogClosedEventArgs extends ASPxClientHtmlEditorCustomDialogCloseEventArgsBase {
/**
* Initializes a new instance of the ASPxClientHtmlEditorCustomDialogClosedEventArgs class with the specified settings.
* @param name A string value that specifies the custom dialog's name. This value is assigned to the ASPxClientHtmlEditorCustomDialogEventArgs.name property.
* @param status An object that specifies a status that is returned to the parent control when the custom dialog is closed. This value is assigned to the ASPxClientHtmlEditorCustomDialogCloseEventArgsBase.status property.
* @param data An object that specifies the data that is returned to the parent control when the custom dialog is closed. This value is assigned to the ASPxClientHtmlEditorCustomDialogClosedEventArgs.data property.
*/
constructor(name: string, status: any, data: any);
/**
* Gets an object associated with the closed dialog.
*/
data: any;
}
/**
* A method that will handle the client ASPxClientHtmlEditor.Validation event.
* @param source An object representing the event's source.
* @param e An ASPxClientHtmlEditorValidationEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorValidationEventHandler { (source: Sender, e: ASPxClientHtmlEditorValidationEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.Validation client event.
*/
declare class ASPxClientHtmlEditorValidationEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientHtmlEditorValidationEventArgs class.
* @param html A string value that specifies the HTML content to validate. This value is assigned to the ASPxClientHtmlEditorValidationEventArgs.html property.
* @param isValid true if the validation has been completed successfully; otherwise, false. This value is assigned to the ASPxClientHtmlEditorValidationEventArgs.isValid property.
* @param errorText A string value representing the error description. This value is assigned to the ASPxClientHtmlEditorValidationEventArgs.errorText property.
*/
constructor(html: string, isValid: boolean, errorText: boolean);
/**
* Gets or sets the HTML markup that is the ASPxHtmlEditor's content.
*/
html: string;
/**
* Gets or sets a value specifying whether the validated value is valid.
*/
isValid: boolean;
/**
* Gets or sets the error text to be displayed within the editor's error frame if the editor's validation fails.
*/
errorText: string;
}
/**
* A method that will handle the client ASPxClientHtmlEditor.ActiveTabChanged event.
* @param source The event's source.
* @param e An ASPxClientHtmlEditorTabEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorTabEventHandler { (source: Sender, e: ASPxClientHtmlEditorTabEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.ActiveTabChanged event that concerns manipulations on tabs.
*/
declare class ASPxClientHtmlEditorTabEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new object of the ASPxClientHtmlEditorTabEventArgs type with the specified setting.
* @param name A string value that uniquely identifies the name of a tab related to the event.
*/
constructor(name: string);
/**
* Gets the name that uniquely identifies an editor tab.
*/
name: string;
}
/**
* A method that will handle the client ASPxClientHtmlEditor.ActiveTabChanging event.
* @param source The event's source.
* @param e An ASPxClientHtmlEditorTabCancelEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorTabCancelEventHandler { (source: Sender, e: ASPxClientHtmlEditorTabCancelEventArgs): void; }
/**
* Provides data for the cancellable ASPxClientHtmlEditor.ActiveTabChanging event that concerns manipulations on tabs.
*/
declare class ASPxClientHtmlEditorTabCancelEventArgs extends ASPxClientHtmlEditorTabEventArgs {
/**
* Initializes a new object of the ASPxClientHtmlEditorTabCancelEventArgs type with the specified setting.
* @param name A string value that uniquely identifies the name of a tab related to the event.
*/
constructor(name: string);
/**
* Gets or sets a value indicating whether the action which raised the event, should be canceled.
*/
cancel: boolean;
}
/**
* A method that will handle the ASPxClientHtmlEditor.BeforePaste event.
* @param source The event source. This parameter identifies the HTML editor object that raised the event.
* @param e An ASPxClientHtmlEditorBeforePasteEventArgs object that contains event data.
*/
interface ASPxClientHtmlEditorBeforePasteEventHandler { (source: Sender, e: ASPxClientHtmlEditorBeforePasteEventArgs): void; }
/**
* Provides data for the ASPxClientHtmlEditor.BeforePaste event.
*/
declare class ASPxClientHtmlEditorBeforePasteEventArgs extends ASPxClientEventArgs {
/**
* Initialize a new instance of the ASPxClientHtmlEditorBeforePasteEventArgs class with the specified settings.
* @param commandName A string value identifying the command's name.
* @param html A string value that specifies the HTML content to paste.
*/
constructor(commandName: string, html: string);
/**
* Gets the name of the processed command.
*/
commandName: string;
/**
* Gets or sets the HTML markup that is about to be pasted to the ASPxHtmlEditor's content.
*/
html: string;
}
/**
* Represents a client-side equivalent of the ASPxHtmlEditor control.
*/
declare class ASPxClientHtmlEditor extends ASPxClientControl {
/**
* Occurs on the client side after a dialog has been initialized.
*/
DialogInitialized: ASPxClientEvent>;
/**
* Fires on the client side before a dialog is going to be closed.
*/
DialogClosing: ASPxClientEvent>;
/**
* Occurs on the client side after a dialog is closed.
*/
DialogClosed: ASPxClientEvent>;
/**
* Occurs before a default or custom command has been executed and allows you to cancel the action.
*/
CommandExecuting: ASPxClientEvent>;
/**
* Enables you to implement a custom command's logic.
*/
CustomCommand: ASPxClientEvent>;
/**
* Occurs after a default or custom command has been executed on the client side.
*/
CommandExecuted: ASPxClientEvent>;
/**
* Fires on the client side when the editor's Design View Area receives input focus.
*/
GotFocus: ASPxClientEvent>;
/**
* Fires on the client side when the editor's Design View Area loses input focus.
*/
LostFocus: ASPxClientEvent>;
/**
* Occurs on the client when a selection is changed within the ASPxHtmlEditor.
*/
SelectionChanged: ASPxClientEvent>;
/**
* Occurs on the client side when the content of the editor changes.
*/
HtmlChanged: ASPxClientEvent>;
/**
* Occurs on the client side after a custom dialog is opened.
*/
CustomDialogOpened: ASPxClientEvent>;
/**
* Fires on the client side before a custom dialog is closed.
*/
CustomDialogClosing: ASPxClientEvent>;
/**
* Occurs on the client side after a custom dialog is closed.
*/
CustomDialogClosed: ASPxClientEvent>;
/**
* Allows you to specify whether the value entered into the ASPxHtmlEditor is valid.
*/
Validation: ASPxClientEvent>;
/**
* Occurs on the client side before a context menu is shown.
*/
ContextMenuShowing: ASPxClientEvent>;
/**
* Occurs when a callback for server-side processing is initiated.
*/
BeginCallback: ASPxClientEvent>;
/**
* Occurs on the client side after a callback's server-side processing has been completed.
*/
EndCallback: ASPxClientEvent>;
/**
* Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientHtmlEditor.
*/
CallbackError: ASPxClientEvent>;
/**
* Fires after a callback, sent by the ASPxClientHtmlEditor.PerformDataCallback method, has been processed within the ASPxHtmlEditor.CustomDataCallback event handler.
*/
CustomDataCallback: ASPxClientEvent>;
/**
* Occurs on the client side after the editor content is spell checked.
*/
SpellingChecked: ASPxClientEvent>;
/**
* Fires on the client side after the active tab has been changed within a control.
*/
ActiveTabChanged: ASPxClientEvent>;
/**
* Fires on the client side before the active tab is changed within a control.
*/
ActiveTabChanging: ASPxClientEvent>;
/**
* Occurs before an HTML code is pasted to editor content, and allows you to modify it.
*/
BeforePaste: ASPxClientEvent>;
/**
* Returns the document object generated by an iframe element within a design view area.
*/
GetDesignViewDocument(): any;
/**
* Provides access to the client ASPxPopupControl object that is a Html Editor's dialog.
*/
GetDialogPopupControl(): ASPxClientPopupControl;
/**
* Returns the document object generated by an iframe element within a preview area.
*/
GetPreviewDocument(): any;
/**
* Returns a collection of client context menu objects.
*/
GetContextMenu(): ASPxClientPopupMenu;
/**
* Returns a value indicating whether an editor is enabled.
*/
GetEnabled(): boolean;
/**
* Specifies whether an editor is enabled.
* @param value true to enable the editor; false to disable it.
*/
SetEnabled(value: boolean): void;
/**
* Sets input focus to the ASPxHtmlEditor's edit region.
*/
Focus(): void;
/**
* Gets the HTML markup that represents the editor's content.
*/
GetHtml(): string;
/**
* Sets the HTML markup that represents the editor's content.
* @param html A string value that specifies the HTML markup.
* @param clearUndoHistory true to clear the undo stack; otherwise, false.
*/
SetHtml(html: string, clearUndoHistory?: boolean): void;
/**
* Replaces placeholders with the specified values. A string value that is the resulting HTML code with the placeholders replaced.
* @param html A string value that specifies the HTML code to process.
* @param placeholders An array of objects that specify the placeholders and values to replace them.
*/
ReplacePlaceholders(html: string, placeholders: any[]): string;
/**
* Creates a parameter for ASPxHtmlEditor's client-side commands related to changing media elements. An ASPxClientHtmlEditorChangeMediaElementCommandArguments object which contains the current settings of the changed element.
* @param element An element that is being changed.
*/
CreateChangeMediaElementCommandArguments(element: any): ASPxClientHtmlEditorChangeMediaElementCommandArguments;
/**
* Executes the specified command. true, if the specified command has been completed successfully; otherwise, false.
* @param commandName A string value that specifies the command to perform.
* @param parameter A string value specifying additional information about the command to perform.
* @param addToUndoHistory true, to add the specified command to the undo stack; otherwise, false.
*/
ExecuteCommand(commandName: string, parameter: any, addToUndoHistory: boolean): boolean;
/**
* Adds the current editor state to the undo/redo history.
*/
SaveToUndoHistory(): void;
/**
* Returns the selection in the ASPxHtmlEditor.
*/
GetSelection(): ASPxClientHtmlEditorSelection;
/**
* Restores the selection within the ASPxHtmlEditor.
*/
RestoreSelection(): boolean;
/**
* Sets the value of the combo box within the HtmlEditor on the client side.
* @param commandName A string value that identifies the combo box's command name within the HtmlEditor's control collection.
* @param value A string value that specifies the combo box's new value.
*/
SetToolbarComboBoxValue(commandName: string, value: string): void;
/**
* Sets the value of the dropdown item picker in the HtmlEditor on the client side.
* @param commandName A string value that identifies the dropdown item picker by its command name. This value is contained in the ToolbarDropDownItemPicker.CommandName property.
* @param value A string value that specifies the dropdown item picker's new value, i.e., the ToolbarCustomItem.Value property value of the newly selected ToolbarItemPickerItem object.
*/
SetToolbarDropDownItemPickerValue(commandName: string, value: string): void;
/**
* Specifies the visibility of a ribbon context tab category specified by its name.
* @param categoryName A String value that is the RibbonContextTabCategory.Name property value of the required category.
* @param active true to make a category visible; false to make it hidden.
*/
SetRibbonContextTabCategoryVisible(categoryName: string, active: string): void;
/**
* Provides access to an object implementing the HtmlEditor's ribbon UI.
*/
GetRibbon(): ASPxClientRibbon;
/**
* Gets a value that indicates whether the editor's value passes validation.
*/
GetIsValid(): boolean;
/**
* Gets the error text to be displayed within the editor's error frame if the editor's validation fails.
*/
GetErrorText(): string;
/**
* Sets a value that specifies whether the editor's value passes validation.
* @param isValid true if the editor's value passes validation; otherwise, false.
*/
SetIsValid(isValid: boolean): void;
/**
* Sets the error text to be displayed within the editor's error frame if the editor's validation fails.
* @param errorText A string value representing the error text.
*/
SetErrorText(errorText: string): void;
/**
* Performs validation of the editor's content.
*/
Validate(): void;
/**
* Returns a toolbar specified by its name. An ASPxClientMenu object that is the toolbar with the specified 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.
*/
SetActiveTabByName(name: string): void;
/**
* Returns the name of the active HTML editor tab.
*/
GetActiveTabName(): string;
/**
* Reconnect the control to an external ribbon.
*/
ReconnectToExternalRibbon(): void;
/**
* Sends a callback to the server and generates the server-side ASPxHtmlEditor.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 ASPxHtmlEditor.CustomDataCallback event.
* @param onCallback A ASPxClientDataCallback object that represents the JavaScript function which receives the callback data as a parameter.
*/
PerformDataCallback(parameter: string, onCallback: ASPxClientDataCallback): void;
/**
* Converts the specified object to the ASPxClientHtmlEditor type. The converted client object specified by the obj parameter.
* @param obj The client object to be type cast.
*/
static Cast(obj: any): ASPxClientHtmlEditor;
/**
* Programmatically closes a custom dialog, supplying it with specific parameters.
* @param status An object representing a custom dialog's closing status.
* @param data An object representing custom data associated with a custom dialog.
*/
static CustomDialogComplete(status: any, data: any): 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.
*/
static HighlightText(text: string, searchContainer: any, color?: string, backgroundColor?: string): void;
}
/**
* Provides client functionality for dialogs within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorDialogBase {
/**
* Provides access to the client ASPxFormLayout object that arranges all editors in the Html Editor's dialogs.
*/
GetFormLayout(): ASPxClientFormLayout;
/**
* Provides access to the client object of the "OK" button in the Html Editor's dialogs.
*/
GetOkButton(): ASPxClientButton;
/**
* Provides access to the client object of the "Cancel" button in the Html Editor's dialogs.
*/
GetCancelButton(): ASPxClientButton;
}
/**
* Provides client functionality for Html Editor dialogs operated with its elements.
*/
declare class ASPxClientHtmlEditorEditElementDialog extends ASPxClientHtmlEditorDialogBase {
/**
* Provides access to the client object of the "Border style" combo box in the Html Editor's dialogs (Style Settings).
*/
GetBorderStyleComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Border width" spin editor in the Html Editor's dialogs (Style Settings).
*/
GetBorderWidthSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Border color" color editor in the Html Editor's dialogs (Style Settings).
*/
GetBorderColorColorEdit(): ASPxClientColorEdit;
/**
* Provides access to the client object of the "Top margin" text box in the Html Editor's dialogs (Style Settings).
*/
GetTopMarginTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Bottom margin" text box in the Html Editor's dialogs (Style Settings).
*/
GetBottomMarginTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Left margin" text box in the Html Editor's dialogs (Style Settings).
*/
GetLeftMarginTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Right margin" text box in the Html Editor's dialogs (Style Settings).
*/
GetRightMarginTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "CSS class" combo box in the Html Editor's dialogs (Style Settings).
*/
GetCssClassNameComboBox(): ASPxClientComboBox;
}
/**
* Provides client functionality for the Change Element Properties dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorChangeElementPropertiesDialog extends ASPxClientHtmlEditorEditElementDialog {
/**
* Provides access to the client object of the "ID" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetIdTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Title" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetTitleTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Direction" combo box in the Html Editor's "Change Element Properties" dialog.
*/
GetDirectionComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Value" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetValueTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Tab index" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetTabIndexTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Disabled" check box in the Html Editor's "Change Element Properties" dialog.
*/
GetDisabledCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Input type" combo box in the Html Editor's "Change Element Properties" dialog.
*/
GetInputTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "For" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetForTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Name" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetNameTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Method" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetMethodTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Action" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetActionTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Checked" check box in the Html Editor's "Change Element Properties" dialog.
*/
GetCheckedCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Max length" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetMaxLengthTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Size" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetSizeTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Readonly" check box in the Html Editor's "Change Element Properties" dialog.
*/
GetReadonlyCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Src" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetSrcTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Accept" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetAcceptTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Alt" text box in the Html Editor's "Change Element Properties" dialog.
*/
GetAltTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Start" spin editor in the Html Editor's "Change Element Properties" dialog.
*/
GetStartSpinEdit(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Width" spin editor in the Html Editor's "Change Element Properties" dialog.
*/
GetWidthValueSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client ASPxComboBox object that allows you to specify the element width measurement unit in the Html Editor's "Change Element Properties" dialog.
*/
GetWidthValueTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Height" spin editor in the Html Editor's "Change Element Properties" dialog.
*/
GetHeightValueSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client ASPxComboBox object that allows to specify the element height measurement unit in the Html Editor's "Change Element Properties" dialog.
*/
GetHeightValueTypeComboBox(): ASPxClientComboBox;
}
/**
* Provides client functionality for the Link dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorLinkDialog extends ASPxClientHtmlEditorDialogBase {
/**
* Provides access to the client object of the "E-mail to" text box in the Html Editor's Link dialog.
*/
GetEmailTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Text" text box in the Html Editor's Link dialog.
*/
GetTextTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "ToolTip" text box in the Html Editor's Link dialog.
*/
GetTooltipTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Subject" text box in the Html Editor's Link dialog.
*/
GetSubjectTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "URL" text box in the Html Editor's Link dialog.
*/
GetUrlTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the file manager used in the Link dialog's "Select Document" popup window.
*/
GetFileManager(): ASPxClientFileManager;
/**
* Provides access to the client object of the "Cancel" button in the Link dialog's "Select Document" popup window.
*/
GetSelectDocumentPopupCancelButton(): ASPxClientButton;
/**
* Provides access to the client object of the "Select" button in the Link dialog's "Select Document" popup window.
*/
GetSelectDocumentPopupSelectButton(): ASPxClientButton;
/**
* Provides access to the client popup control object that is the "Select Document" popup window in the Html Editor's Link dialog.
*/
GetSelectDocumentPopupControl(): ASPxClientPopupControl;
/**
* Provides access to the client object of the "Open in new window" check box in the Html Editor's Link dialog.
*/
GetOpenInNewWindowCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client radio button list object used to specify the link type in the Html Editor's Link dialog.
*/
GetLinkTypeRadioButtonList(): ASPxClientRadioButtonList;
}
/**
* Provides client functionality for the Placeholder dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorPlaceholderDialog extends ASPxClientHtmlEditorDialogBase {
/**
* Provides access to the ASPxListBox client object that lists placeholder names in the Html Editor's Placeholder dialog.
*/
GetPlaceholderNameListBox(): ASPxClientListBox;
}
/**
* Provides client functionality for the Paste From Word dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorPasteFromWordDialog extends ASPxClientHtmlEditorDialogBase {
/**
* Provides access to the client object of the "Remove font family" check box in the Html Editor's Flash dialog.
*/
GetRemoveFontFamilyCheckBox(): ASPxClientCheckBox;
}
/**
* Provides client functionality for the media dialogs within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorMediaDialogBase extends ASPxClientHtmlEditorEditElementDialog {
/**
* Provides access to the client object of the media file selector that allows you to insert/change media files in the Html Editor's Audio/Video/Flash dialogs.
*/
GetMediaFileSelector(): ASPxClientMediaFileSelector;
/**
* Provides access to the client object of the "More options" check box in the Html Editor's Audio/Video/Flash/Image dialogs.
*/
GetMoreOptionsCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Width" spin editor in the Html Editor's Audio/Video/Flash dialogs.
*/
GetWidthSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Height" spin editor in the Html Editor's Audio/Video/Flash dialogs.
*/
GetHeightSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Position" combo box in the Html Editor's Audio/Video/Flash/Image dialogs.
*/
GetPositionComboBox(): ASPxClientComboBox;
}
/**
* Provides client functionality for the Image dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorImageDialog extends ASPxClientHtmlEditorMediaDialogBase {
/**
* Provides access to the client object of the "Size" combo box in the Html Editor's Image dialog.
*/
GetSizeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Create thumbnail" check box in the Html Editor's Image dialog.
*/
GetCreateThumbnailCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "New image name" text box in the Html Editor's Image dialog.
*/
GetThumbnailNameTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Wrap text around image" check box in the Html Editor's Image dialog.
*/
GetWrapTextCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Description" text box in the Html Editor's Image dialog.
*/
GetDescriptionTextBox(): ASPxClientTextBox;
}
/**
* Provides client functionality for the Flash dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorFlashDialog extends ASPxClientHtmlEditorMediaDialogBase {
/**
* Provides access to the client object of the "Quality" combo box in the Html Editor's Flash dialog.
*/
GetQualityComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Auto play" check box in the Html Editor's Flash dialog.
*/
GetAutoPlayCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Enable flash menu" check box in the Html Editor's Flash dialog.
*/
GetEnableFlashMenuCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Loop" check box in the Html Editor's Flash dialog.
*/
GetLoopCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Allow fullscreen" check box in the Html Editor's Flash dialog.
*/
GetAllowFullscreenCheckBox(): ASPxClientCheckBox;
}
/**
* Provides client functionality for the Audio dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorAudioDialog extends ASPxClientHtmlEditorMediaDialogBase {
/**
* Provides access to the client object of the "Auto play" check box in the Html Editor's Audio dialogs.
*/
GetAutoPlayCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Preload mode" combo box in the Html Editor's Audio dialogs.
*/
GetPreloadModeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Loop" check box in the Html Editor's Audio dialogs.
*/
GetLoopCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Show player controls" check box in the Html Editor's Audio dialogs.
*/
GetShowPlayerControlsCheckBox(): ASPxClientCheckBox;
}
/**
* Provides client functionality for the Video dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorVideoDialog extends ASPxClientHtmlEditorMediaDialogBase {
/**
* Provides access to the client object of the "Auto play" check box in the Html Editor's Video dialog.
*/
GetAutoPlayCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Preload mode" combo box in the Html Editor's Video dialog.
*/
GetPreloadModeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Loop" check box in the Html Editor's Video dialog.
*/
GetLoopCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Show player controls" check box in the Html Editor's Video dialog.
*/
GetShowPlayerControlsCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Poster URL" text box in the Html Editor's Video dialog.
*/
GetPosterTextBox(): ASPxClientTextBox;
}
/**
* Provides client functionality for the YouTube Video dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorYouTubeDialog extends ASPxClientHtmlEditorEditElementDialog {
/**
* Provides access to the client object of the "Enable privacy-enhanced mode" check box in the Html Editor's YouTube Video dialog.
*/
GetConfidentModeCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Show suggested videos when the video finishes" check box in the Html Editor's YouTube Video dialog.
*/
GetShowSameVideosCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Show video title and player actions" check box in the Html Editor's YouTube Video dialog.
*/
GetShowVideoNameCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Show player controls" check box in the Html Editor's YouTube Video dialog.
*/
GetShowPlayerControlsCheckBox(): ASPxClientCheckBox;
/**
* Provides access to the client object of the "Allow fullscreen" check box in the Html Editor's "Insert YouTube Video" dialog.
*/
GetAllowFullscreenCheckBox(): ASPxClientCheckBox;
}
/**
* Provides base client functionality for the Table dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorTableDialogBase extends ASPxClientHtmlEditorDialogBase {
/**
* Provides access to the client object of the "Background color" color editor in the Html Editor's Table dialogs.
*/
GetBackgroundColorColorEdit(): ASPxClientColorEdit;
}
/**
* Provides client functionality for the Table dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorTableDialog extends ASPxClientHtmlEditorTableDialogBase {
/**
* Provides access to the client object of the "Width" combo box in the Html Editor's Table dialogs.
*/
GetWidthTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the spin editor in the Html Editor's Table dialogs that allows you to specify the table width value.
*/
GetWidthValueSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the combo box in the Html Editor's Table dialogs that allows you to specify the table width measurement unit.
*/
GetWidthValueTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Height" combo box in the Html Editor's Table dialogs.
*/
GetHeightTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the spin editor in the Html Editor's Table dialogs that allows you specify the table height value.
*/
GetHeightValueSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the combo box in the Html Editor's Table dialogs that allows you to specify the table height measurement unit.
*/
GetHeightValueTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Cell padding" spin editor in the Html Editor's Table dialogs.
*/
GetCellPaddingSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Cell spacing" spin editor in the Html Editor's Table dialogs.
*/
GetCellSpacingSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Alignment" combo box in the Html Editor's Table dialogs.
*/
GetAlignmentComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Border Color" color editor in the Html Editor's Table dialogs.
*/
GetBorderColorColorEdit(): ASPxClientColorEdit;
/**
* Provides access to the client object of the "Border size" spin editor in the Html Editor's Table dialogs.
*/
GetBorderWidthSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Headers" combo box in the Html Editor's Table dialogs.
*/
GetHeadersComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Caption" text box in the Html Editor's Table dialogs.
*/
GetCaptionTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Summary" text box in the Html Editor's Table dialogs.
*/
GetSummaryTextBox(): ASPxClientTextBox;
/**
* Provides access to the client object of the "Accessibility" check box related to the Html Editor's Table dialogs.
*/
GetAccessibilityCheckBox(): ASPxClientCheckBox;
}
/**
* Provides client functionality for the Insert Table dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorInsertTableDialog extends ASPxClientHtmlEditorTableDialog {
/**
* Provides access to the client object of the "Columns" spin editor in the Html Editor's Table dialogs.
*/
GetColumnCountSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Rows" spin editor in the Html Editor's Table dialogs.
*/
GetRowCountSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the "Equal column widths" check box in the Html Editor's Table dialogs.
*/
GetEqualWidthCheckBox(): ASPxClientCheckBox;
}
/**
* Provides client functionality for Table dialogs within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorTableElementPropertiesDialog extends ASPxClientHtmlEditorTableDialogBase {
/**
* Provides access to the client object of the "Horizontal" combo box in the Html Editor's Row/Column/Cell Properties dialog's Alignment group.
*/
GetHorizontalAlignmentComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the "Vertical" combo box in the Html Editor's Row/Column/Cell Properties dialog's Alignment group.
*/
GetVerticalAlignmentComboBox(): ASPxClientComboBox;
}
/**
* Provides client functionality for the Cell Properties dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorTableCellPropertiesDialog extends ASPxClientHtmlEditorTableElementPropertiesDialog {
/**
* Provides access to the client object of the "Apply to all cells in the table" check box in the Html Editor's Cell Properties dialog.
*/
GetApplyToAllCellsCheckBox(): ASPxClientCheckBox;
}
/**
* Provides client functionality for the Row Properties dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorTableRowPropertiesDialog extends ASPxClientHtmlEditorTableElementPropertiesDialog {
/**
* Provides access to the client object of the "Height" combo box in the Html Editor's "Row Properties" dialog.
*/
GetHeightTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client ASPxSpinEdit object that allows you to specify the row height in the Html Editor's "Row Properties" dialog.
*/
GetHeightValueSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client ASPxComboBox object that allows you to specify the row height measurement unit in the Html Editor's "Row Properties" dialog.
*/
GetHeightValueTypeComboBox(): ASPxClientComboBox;
}
/**
* Provides client functionality for the Column Properties dialog within the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorTableColumnPropertiesDialog extends ASPxClientHtmlEditorTableElementPropertiesDialog {
/**
* Provides access to the client object of the "Width" combo box in the Html Editor's "Column Properties" dialog.
*/
GetWidthTypeComboBox(): ASPxClientComboBox;
/**
* Provides access to the client object of the spin editor that allows you to set the column width value in the Html Editor's "Column Properties" dialog.
*/
GetWidthValueSpinEdit(): ASPxClientSpinEdit;
/**
* Provides access to the client object of the combo box that allows you to specify the column width measurement unit in the Html Editor's "Column Properties" dialog.
*/
GetWidthValueTypeComboBox(): ASPxClientComboBox;
}
/**
* Lists the values that specify how a media file should be loaded when the page loads.
*/
declare class ASPxClientHtmlEditorMediaPreloadMode {
/**
* The browser does not load a media file when the page loads.
*/
static readonly None: string;
/**
* The browser loads the entire video when the page loads.
*/
static readonly Auto: string;
/**
* The browser loads only metadata when the page loads.
*/
static readonly Metadata: string;
}
/**
* A selection in the ASPxHtmlEditor.
*/
declare class ASPxClientHtmlEditorSelection {
/**
* Returns a DOM element that relates to the current selection.
*/
GetSelectedElement(): any;
/**
* Returns the HTML markup specifying the currently selected ASPxHtmlEditor content.
*/
GetHtml(): string;
/**
* Returns the text within the currently selected ASPxHtmlEditor content.
*/
GetText(): string;
/**
* Returns an array of the currently selected elements.
*/
GetElements(): any[];
/**
* Sets the new HTML markup in place of the currently selected within ASPxHtmlEditor content.
* @param html A string value specifying the new HTML markup.
* @param addToHistory true to add this operation to the history; otherwise, false.
*/
SetHtml(html: string, addToHistory: boolean): void;
}
declare class ASPxClientPivotGridControlCollection extends ASPxClientControlCollection {
static GetPivotGridControlCollection(): ASPxClientPivotGridControlCollection;
}
/**
* The client-side equivalent of the ASPxPivotGrid control.
*/
declare class ASPxClientPivotGrid extends ASPxClientControl {
/**
* Occurs on the client after a callback's server-side processing has been completed.
*/
EndCallback: ASPxClientEvent>;
/**
* Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientPivotGrid.
*/
CallbackError: ASPxClientEvent>;
/** @deprecated Use the EndCallback event instead */
/**
* Fires after a callback that has been processed on the server returns back to the client.
*/
AfterCallback: ASPxClientEvent>;
/**
* Occurs when a callback for server-side processing is initiated.
*/
BeginCallback: ASPxClientEvent>;
/** @deprecated Use the BeginCallback event instead */
/**
* Fires before a callback is sent to the server for server-side processing.
*/
BeforeCallback: ASPxClientEvent>;
/**
* Indicates whether the Defer Layout Update check box is enabled.
*/
IsDeferUpdatesChecked(): boolean;
/**
* Indicates whether the Filter Editor (Prefilter) is visible.
*/
IsPrefilterVisible(): boolean;
/**
* Shows the Filter Editor.
*/
ShowPrefilter(): void;
/**
* Hides the Filter Editor.
*/
HidePrefilter(): void;
/**
* Clears the filter expression applied using the Prefilter (Filter Editor).
*/
ClearPrefilter(): void;
/**
* Enables or disables the current filter applied by the Filter Editor (Prefilter).
*/
ChangePrefilterEnabled(): void;
/**
* Fires on the client side after the customization form's visible state has been changed.
*/
CustomizationFieldsVisibleChanged: ASPxClientEvent>;
/**
* Occurs when a cell is clicked.
*/
CellClick: ASPxClientEvent>;
/**
* Occurs when a cell is double clicked.
*/
CellDblClick: ASPxClientEvent>;
/**
* Occurs when a custom menu item has been clicked.
*/
PopupMenuItemClick: ASPxClientEvent>;
/**
* Returns a value that specifies whether the customization form is visible.
*/
GetCustomizationFieldsVisibility(): boolean;
/**
* Specifies the visibility of the customization form.
* @param value true to display the customization form; false to hide the customization form.
*/
SetCustomizationFieldsVisibility(value: boolean): void;
/**
* Switches the customization form's visible state.
*/
ChangeCustomizationFieldsVisibility(): void;
/**
* Sends a callback to the server and generates the server-side ASPxPivotGrid.CustomCallback event, passing it the specified argument.
* @param args A string value that represents any information that needs to be sent to the server-side ASPxPivotGrid.CustomCallback event.
* @param onSuccess A client action to perform if the server round-trip completed successfully.
*/
PerformCallback(args: string, onSuccess?: (arg: string) => void): void;
/**
* Converts the specified object to the ASPxClientPivotGrid type. The converted client object specified by the obj parameter.
* @param obj The client object to be type cast.
*/
static Cast(obj: any): ASPxClientPivotGrid;
}
/**
* A method that will handle the ASPxClientPivotGrid.CellClick or ASPxClientPivotGrid.CellDblClick event.
* @param source The event source.
* @param e An ASPxClientClickEventArgs object that contains event data.
*/
interface ASPxClientClickEventHandler { (source: Sender, e: ASPxClientClickEventArgs): void; }
/**
* Provides data for the ASPxClientPivotGrid.CellClick and ASPxClientPivotGrid.CellDblClick client events.
*/
declare class ASPxClientClickEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientClickEventArgs class.
* @param value An object that represents the processed cell's value. This value is assigned to the ASPxClientClickEventArgs.Value property.
* @param columnIndex An integer value that identifies a column. This value is assigned to the ASPxClientClickEventArgs.ColumnIndex property.
* @param rowIndex An integer value that identifies a row. This value is assigned to the ASPxClientClickEventArgs.RowIndex property.
* @param columnValue An object that represents a column field value. This value is assigned to the ASPxClientClickEventArgs.ColumnValue property.
* @param rowValue An object that represents a row field value. This value is assigned to the ASPxClientClickEventArgs.RowValue property.
* @param columnFieldName A String value that represents a column field name. This value is assigned to the ASPxClientClickEventArgs.ColumnFieldName property.
* @param rowFieldName A String value that represents a row field name. This value is assigned to the ASPxClientClickEventArgs.RowFieldName property.
* @param columnValueType A String value that represents a column value type. This value is assigned to the ASPxClientClickEventArgs.ColumnValueType property.
* @param rowValueType A String value that represents a row value type. This value is assigned to the ASPxClientClickEventArgs.RowValueType property.
* @param dataIndex An integer value that identifies the data field by its index. This value is assigned to the ASPxClientClickEventArgs.DataIndex property.
*/
constructor(value: any, columnIndex: number, rowIndex: number, columnValue: any, rowValue: any, columnFieldName: string, rowFieldName: string, columnValueType: string, rowValueType: string, dataIndex: number);
/**
* Provides access to the parameters associated with the ASPxClientPivotGrid.CellClick and ASPxClientPivotGrid.CellDblClick events.
*/
HtmlEvent: any;
/**
* Gets the processed cell's value.
*/
Value: any;
/**
* Gets the index of a column that owns the processed cell.
*/
ColumnIndex: number;
/**
* Gets the index of a row that owns the processed cell.
*/
RowIndex: number;
/**
* Gets a column field value.
*/
ColumnValue: any;
/**
* Gets a row field value.
*/
RowValue: any;
/**
* Gets a column field name.
*/
ColumnFieldName: string;
/**
* Gets a row field name.
*/
RowFieldName: string;
/**
* Gets a column value type.
*/
ColumnValueType: string;
/**
* Gets a row value type.
*/
RowValueType: string;
/**
* Gets the index of the data field which corresponds to the clicked summary value.
*/
DataIndex: number;
}
/**
* A method that will handle the ASPxClientPivotGrid.PopupMenuItemClick event.
* @param source The event source.
* @param e An ASPxClientPivotMenuItemClickEventArgs object that contains event data.
*/
interface ASPxClientPivotMenuItemClickEventHandler { (source: Sender, e: ASPxClientPivotMenuItemClickEventArgs): void; }
/**
* Provides data for the ASPxClientPivotGrid.PopupMenuItemClick event.
*/
declare class ASPxClientPivotMenuItemClickEventArgs extends ASPxClientEventArgs {
/**
* Gets the context menu's type.
*/
MenuType: string;
/**
* Gets the name of the menu item currently being clicked.
*/
MenuItemName: string;
/**
* Gets the field's unique indentifier.
*/
FieldID: string;
/**
* Gets the index of the field value for which the popup menu has been invoked.
*/
FieldValueIndex: number;
Area: string;
}
/**
* A client-side equivalent of the ASPxPivotCustomizationControl control.
*/
declare class ASPxClientPivotCustomization extends ASPxClientControl {
/**
* Returns an HTML element that represents the root of the control's hierarchy.
*/
GetMainContainer(): any;
/**
* Returns a client-side equivalent of the owner Pivot Grid Control.
*/
GetPivotGrid(): ASPxClientPivotGrid;
/**
* Specifies the Customization Control's height.
* @param value An integer value that specifies the Customization Control's height.
*/
SetHeight(value: number): void;
/**
* Specifies the Customization Control's width.
* @param value An integer value that specifies the Customization Control's width.
*/
SetWidth(value: number): void;
/**
* Recalculates the Customization Control height.
*/
UpdateHeight(): void;
/**
* Specifies the Customization Control's layout.
* @param layout A string that specifies the Customization Control's layout.
*/
SetLayout(layout: string): void;
}
/**
* Lists file document formats.
*/
declare enum DocumentFormat {
/**
* The document's format is undefined.
*/
Undefined = 0,
/**
* The plain text format.
*/
PlainText = 1,
/**
* The Rich Text Format (RTF).
*/
Rtf = 2,
/**
* The HTML format.
*/
Html = 3,
/**
* The OpenXML file format (aka default MS Office 2007 format or .docx)
*/
OpenXml = 4,
/**
* The MHT format - web page archive format used to save HTML code with resources represented by external links (images etc.), in a single file
*/
Mht = 5,
/**
* The WordprocessingML format (.xml, implemented in MS Office 2003).
*/
WordML = 6,
/**
* The OpenDocument text format (.odt, implemented by OpenOffice.org office suite).
*/
OpenDocument = 7,
/**
* EPUB® - standard format for electronic books and other digital publications.
*/
ePub = 9,
/**
* MS Word 97-2003 binary file format.
*/
Doc = 10
}
/**
* Contains spell checking related settings.
*/
declare class SpellingInfo {
/**
* Gets a value specifying the spell checking state.
*/
readonly spellCheckerState: SpellCheckerState;
/**
* Provides access to an array containing misspelled intervals.
*/
readonly misspelledIntervals: MisspelledInterval[];
}
/**
* Lists values specifying the spell checking state.
*/
declare enum SpellCheckerState {
/**
* Spell checking is disabled.
*/
Disabled = 0,
/**
* Spell checking is in progress.
*/
InProgress = 1,
/**
* Spell checking is completed.
*/
Done = 2
}
/**
* Contains the settings defining a misspelled interval.
*/
declare class MisspelledInterval {
/**
* Gets the start position of the misspelled word in the interval.
*/
readonly start: number;
/**
* Gets the length of the misspelled interval.
*/
readonly length: number;
/**
* Gets the text buffer interval occupied by the current element.
*/
readonly interval: Interval;
/**
* Gets the spelling error type.
*/
readonly errorType: SpellingErrorType;
/**
* Gets an erroneous word found during spell check.
*/
readonly word: string;
/**
* Gets a list of suggested words to replace the misspelled word.
*/
readonly suggestions: string[];
}
/**
* Lists values specifying the spelling error type.
*/
declare enum SpellingErrorType {
/**
* A misspelled word is found.
*/
Misspelling = 0,
/**
* A repeating word is found.
*/
Repeating = 1
}
/**
* Serves as a base for objects implementing different element styles.
*/
declare class StyleBase {
/**
* Gets or sets the name of the style.
*/
readonly name: string;
/**
* Gets whether the specified style is marked as deleted.
*/
readonly isDeleted: boolean;
}
/**
* Defines the paragraph style settings.
*/
declare class ParagraphStyle extends StyleBase {
/**
* Gets or sets the linked style for the current style.
*/
readonly linkedStyle: CharacterStyle;
/**
* Gets or sets the default style for a paragraph that immediately follows the current paragraph.
*/
readonly nextStyle: ParagraphStyle;
/**
* Gets the index of the list item associated with the paragraph formatted with the current style.
*/
readonly listIndex: number;
/**
* Gets the index of the list level applied to the paragraph formatted with the current style.
*/
readonly listLevelIndex: number;
/**
* Gets or sets the style from which the current style inherits.
*/
readonly parent: ParagraphStyle;
}
/**
* Contains characteristics of a character style in a document.
*/
declare class CharacterStyle extends StyleBase {
/**
* Gets or sets the linked style for the current style.
*/
readonly linkedStyle: ParagraphStyle;
/**
* Gets the style form which the current style inherits.
*/
readonly parent: CharacterStyle;
}
/**
* Defines the table style settings.
*/
declare class TableStyle extends StyleBase {
/**
* Gets or sets the style from which the current style inherits.
*/
readonly parent: TableStyle;
}
/**
* Contains a set properties providing the current information about certain document structural elements.
*/
declare class RichEditDocument {
/**
* Provides the information about the active sub-document.
*/
readonly activeSubDocument: SubDocument;
/**
* Provides access to the document's main sub-document.
*/
readonly mainSubDocument: SubDocument;
/**
* Provides access to the document's sub-documents.
*/
readonly subDocuments: SubDocument[];
/**
* Provides information about sections in the current document.
*/
readonly sectionsInfo: Section[];
/**
* Provides information about paragraph styles in the current document.
*/
readonly paragraphStylesInfo: ParagraphStyle[];
/**
* Provides information about character styles in the current document.
*/
readonly characterStylesInfo: CharacterStyle[];
/**
* Provides information about numbered paragraphs in the document.
*/
readonly abstractNumberingListsInfo: AbstractNumberingList[];
/**
* Provides information about table styles in the current document.
*/
readonly tableStylesInfo: TableStyle[];
/**
* Provides information about spell checking in the current document.
*/
readonly spellingInfo: SpellingInfo;
/**
* Returns the sub-document with the specified identifier. A SubDocument value specifying the sub-document.
* @param subDocumentId An integer value specifying the required sub-document.
*/
getSubDocumentById(subDocumentId: number): SubDocument;
}
/**
* An abstract numbering list definition that defines the appearance and behavior of numbered paragraphs in a document.
*/
declare class AbstractNumberingList {
/**
* Gets or sets a value indicating whether an abstract numbering list is deleted.
*/
deleted: boolean;
}
/**
* Defines a paragraph in the document.
*/
declare class Paragraph {
/**
* Gets the paragraph's index.
*/
readonly index: number;
/**
* Gets the paragraph's character length.
*/
readonly length: number;
/**
* Gets the paragraph's start position in the document.
*/
readonly start: number;
/**
* Gets the text buffer interval occupied by the current paragraph element.
*/
readonly interval: Interval;
/**
* Gets the name of the paragraph style applied to the current paragraph (see StyleBase.name).
*/
readonly styleName: string;
/**
* Gets the index of a list applied to the paragraph.
*/
readonly listIndex: number;
/**
* Gets the index of the list level applied to the current paragraph in the numbering list.
*/
readonly listLevelIndex: number;
}
/**
* Defines a field in the document.
*/
declare class Field {
/**
* Gets the field's start position in a document.
*/
readonly start: number;
/**
* Gets the field length in a document.
*/
readonly length: number;
/**
* Gets the text buffer interval occupied by the field code element.
*/
readonly codeInterval: Interval;
/**
* Gets the text buffer interval occupied by the field result element.
*/
readonly resultInterval: Interval;
/**
* Gets the text buffer interval occupied by the current field element.
*/
readonly interval: Interval;
/**
* Gets or sets a URI to navigate to when the hyperlink (represented by the current field) is activated.
*/
readonly hyperlinkUri: string;
/**
* Returns a value specifying whether the field is a hyperlink.
*/
readonly isHyperlink: boolean;
/**
* Gets or sets the text for the tooltip displayed when the mouse hovers over a hyperlink field.
*/
readonly hyperlinkTip: string;
/**
* Gets or sets the name of a bookmark (or a hyperlink) in the current document which shall be the target of the hyperlink field.
*/
readonly hyperlinkAnchor: string;
/**
* Gets a value specifying whether a field's code or result is dispalyed.
*/
readonly showCode: boolean;
/**
* Gets the index of the field
*/
readonly index: number;
}
/**
* Defines a bookmark in the document.
*/
declare class Bookmark {
/**
* Gets the bookmark's start position in a document.
*/
readonly start: number;
/**
* Gets the bookmark's length.
*/
readonly length: number;
/**
* Gets the text buffer interval occupied by the current bookmark element.
*/
readonly interval: Interval;
/**
* Gets the name of a bookmark in the document.
*/
readonly name: string;
}
/**
* Defines a section in the document.
*/
declare class Section {
/**
* Gets the section's start position in the document.
*/
readonly start: number;
/**
* Gets the section's character length.
*/
readonly length: number;
/**
* Gets the text buffer interval occupied by the current section element.
*/
readonly interval: Interval;
/**
* Provides access to the section's headers.
*/
readonly headers: HeaderFooter[];
/**
* Provides access to the section's footers.
*/
readonly footers: HeaderFooter[];
}
/**
* Contains settings defining a header or footer in a document.
*/
declare class HeaderFooter {
/**
* Gets the type of the header (footer).
*/
readonly type: HeaderFooterType;
/**
* Provides access to an object implementing the basic document functionality that is common to the header, footer and the main document body.
*/
readonly subDocument: SubDocument;
}
/**
* Contains in-line picture settings.
*/
declare class InlinePictureInfo {
/**
* Gets the image identifier.
*/
readonly id: number;
/**
* Gets the image position.
*/
readonly position: number;
/**
* Gets the initial image width.
*/
readonly initialWidth: number;
/**
* Gets the initial image height.
*/
readonly initialHeight: number;
/**
* Gets the X-scaling factor of the inline image.
*/
readonly scaleX: number;
/**
* Gets the Y-scaling factor of the inline image.
*/
readonly scaleY: number;
/**
* Gets the actual image width.
*/
readonly actualWidth: number;
readonly actualHeigth: number;
/**
* Gets the actual image height.
*/
readonly actualHeight: number;
}
/**
* Lists the header/footer types.
*/
declare enum HeaderFooterType {
/**
* A header/footer displayed on the first page of the section.
*/
First = 0,
/**
* A header/footer displayed on odd pages of the section.
*/
Odd = 1,
/**
* A header/footer displayed on even pages of the section.
*/
Even = 2,
/**
* A header/footer that is displayed on all pages of the section if the document does not distinguish between first, odd and even pages. Actually, this is an alias for the Odd type.
*/
Primary = 1
}
/**
* Contains the settings defining a file to save to.
*/
declare class RichEditFileInfo {
/**
* Gets or sets the file's folder name.
*/
folderPath: string;
/**
* Gets or sets the file name.
*/
fileName: string;
/**
* Gets or sets the file's document format.
*/
documentFormat: DocumentFormat;
}
/**
* Defines a table in the document.
*/
declare class Table {
/**
* Gets the table's start position in the document.
*/
readonly start: number;
/**
* Gets the table length in characters.
*/
readonly length: number;
/**
* Gets an index of the table.
*/
readonly index: number;
/**
* Gets the text buffer interval occupied by the current table element.
*/
readonly interval: Interval;
/**
* Provides access to a collection of table rows.
*/
readonly rows: TableRow[];
/**
* Gets the name of the style applied to the table (see StyleBase.name).
*/
readonly styleName: string;
}
/**
* Defines a table row in the document.
*/
declare class TableRow {
/**
* Gets the table row's start position in the document.
*/
readonly start: number;
/**
* Gets the table row's character length.
*/
readonly length: number;
/**
* Gets the text buffer interval occupied by the current table row element.
*/
readonly interval: Interval;
/**
* Provides information about the table row's cells.
*/
readonly cells: TableCell[];
}
/**
* Defines a table cell in the document.
*/
declare class TableCell {
/**
* Gets the table cell's start position in the document.
*/
readonly start: number;
/**
* Gets the table cell's character length.
*/
readonly length: number;
/**
* Gets the text buffer interval occupied by the current table cell element.
*/
readonly interval: Interval;
}
/**
* Exposes the settings providing the information about the essential document functionality.
*/
declare class SubDocument {
/**
* Gets the sub-document identifier.
*/
readonly id: number;
/**
* Gets a value specifying the sub-document type.
*/
readonly type: SubDocumentType;
/**
* Provides information about paragraphs contained in the document.
*/
readonly paragraphsInfo: Paragraph[];
/**
* Provides information about fields in the current document.
*/
readonly fieldsInfo: Field[];
/**
* Provides information about tables contained in the document.
*/
readonly tablesInfo: Table[];
/**
* Provides information about document bookmarks.
*/
readonly bookmarksInfo: Bookmark[];
/**
* Provides access to an array of objects containing in-line picture settings.
*/
readonly inlinePicturesInfo: InlinePictureInfo[];
/**
* Gets the document's textual representation.
*/
readonly text: string;
/**
* Gets the character length of the document.
*/
readonly length: number;
/**
* Provides information about floating text boxes contained within the sub-document if it is the main sub-document or header/footer.
*/
readonly floatingTextBoxesInfo: FloatingTextBoxInfo[];
/**
* Provides information about floating pictures in the sub-document.
*/
readonly floatingPicturesInfo: FloatingPictureInfo[];
/**
* Return the document's textual representation contained in the specified interval. A string value specifying the text contained in the specified interval.
* @param interval A text buffer interval that contains the target text.
*/
getTextByInterval(interval: Interval): string;
/**
* Returns information specific for floating text boxes about the sub-document.
*/
getFloatingTextBoxInfo(): FloatingTextBoxInfo;
/**
* Returns an array of fields that match the search conditions. An array of the Field objects.
* @param arg A position or interval indicating where to search fields.
*/
findFields(arg: number | Interval): Field[];
/**
* Returns an array of tables that match the search conditions. An array of the Table objects.
* @param arg Contains a position or interval indicating where to search tables.
*/
findTables(arg: number | Interval): Table[];
/**
* Returns an array of paragraphs that match the search conditions. An array of the Paragraph objects.
* @param arg Contains a position or interval(s) where to search paragraphs.
*/
findParagraphs(arg: number | Interval | Interval[]): Paragraph[];
/**
* Returns an array of bookmarks that match the search conditions. An array of the Bookmark objects.
* @param arg Contains a position or interval(s) where to search bookmarks, or a bookmark name, or a regular expression.
*/
findBookmarks(arg: number | Interval | Interval[] | string | RegExp): Bookmark[];
}
/**
* Lists values specifying the sub-document type.
*/
declare enum SubDocumentType {
/**
* The main document body.
*/
Main = 0,
/**
* A header.
*/
Header = 1,
/**
* A footer.
*/
Footer = 2,
/**
* A text box.
*/
TextBox = 3
}
/**
* Contains floating objects base settings.
*/
declare class FloatingObjectInfo {
/**
* Gets the position of the floating object's anchor in the parent sub-document.
*/
readonly position: number;
/**
* Gets the parent sub-document what stores the current floating object.
*/
readonly parentSubDocument: SubDocument;
}
/**
* Contains floating text boxes settings.
*/
declare class FloatingTextBoxInfo extends FloatingObjectInfo {
/**
* Gets the sub-document representing the floating text box's content.
*/
readonly contentSubDocument: SubDocument;
}
/**
* Contains floating pictures settings.
*/
declare class FloatingPictureInfo extends FloatingObjectInfo {
}
/**
* Contains a set of methods and properties to work with the document selection.
*/
declare class RichEditSelection {
/**
* Gets or sets an array of document intervals in the selection.
*/
intervals: Interval[];
/**
* Selects the specified interval(s).
* @param arg The interval(s) or position to select.
*/
setSelection(arg: number | Interval | Interval[]): void;
/**
* Gets whether a floating picture or text box is selected.
*/
readonly isFloatingObjectSelected: boolean;
/**
* Gets whether only a text box is selected.
*/
readonly isTextBoxSelected: boolean;
/**
* Gets whether only a picture is selected.
*/
readonly isPictureSelected: boolean;
/**
* Gets or sets a value specifying whether the current selection is collapsed (and represents the cursor position).
*/
collapsed: boolean;
/**
* Gets the maximum position of a document interval in the selection.
*/
getIntervalMaxPosition(): number;
/**
* Moves the cursor to the next line and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToNextLine(extendSelection?: boolean): void;
/**
* Moves the cursor to the end of the line in which the cursor is located and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToLineEnd(extendSelection?: boolean): void;
/**
* Moves the cursor to the start of the line in which the cursor is located and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToLineStart(extendSelection?: boolean): void;
/**
* Moves the cursor to the previous line and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToPreviousLine(extendSelection?: boolean): void;
/**
* Moves the cursor to the next character and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToNextCharacter(extendSelection?: boolean): void;
/**
* Moves the cursor to the previous character and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToPreviousCharacter(extendSelection?: boolean): void;
/**
* Selects the line in which the cursor is located and allows you to extend the entire selection with the currently existing selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
selectLine(extendSelection?: boolean): void;
/**
* Moves the cursor to the beginning of the next page and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToNextPage(extendSelection?: boolean): void;
/**
* Moves the cursor to the beginning of the previous page and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToPreviousPage(extendSelection?: boolean): void;
/**
* Moves the cursor to the start of the document and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToDocumentStart(extendSelection?: boolean): void;
/**
* Moves the cursor to the end of the document and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToDocumentEnd(extendSelection?: boolean): void;
/**
* Moves the cursor to the next word and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToNextWord(extendSelection?: boolean): void;
/**
* Moves the cursor to the previous word and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToPrevWord(extendSelection?: boolean): void;
/**
* Moves the cursor to the start of the paragraph in which the cursor is located and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToParagraphStart(extendSelection?: boolean): void;
/**
* Moves the cursor to the end of the paragraph in which the cursor is located and allows you to extend the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToParagraphEnd(extendSelection?: boolean): void;
/**
* Selects the paragraph in which the cursor is located.
*/
selectParagraph(): void;
/**
* Moves the cursor to the next page break mark and extends the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToStartNextPageCommand(extendSelection?: boolean): void;
/**
* Moves the cursor to the previous page break mark and extends the selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
goToStartPrevPageCommand(extendSelection?: boolean): void;
/**
* Selects the table cell in which the cursor is located and allows you to extend the entire selection with the currently existing selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
selectTableCell(extendSelection?: boolean): void;
/**
* Selects the table row in which the cursor is located and allows you to extend the entire selection with the currently existing selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
selectTableRow(extendSelection?: boolean): void;
/**
* Selects the entire table in which the cursor is located and allows you to extend the entire selection with the currently existing selection.
* @param extendSelection true to extend the selection; otherwise, false.
*/
selectTable(extendSelection?: boolean): void;
/**
* Selects the editor's entire content.
*/
selectAll(): void;
/**
* Makes the main sub-document active and moves the cursor to its beginning.
*/
setMainSubDocumentAsActive(): void;
/**
* Creates a footer sub-document (if it was not created before) and sets the footer as the active sub-document. Moves the cursor to the footer's start position.
* @param pageIndex An integer value specifying the active page's index.
*/
setFooterSubDocumentAsActiveByPageIndex(pageIndex: number): void;
/**
* Creates a header sub-document (if it was not created before) and sets the header as the active sub-document. Moves the cursor to the header's start position.
* @param pageIndex An integer value specifying the active page's index.
*/
setHeaderSubDocumentAsActiveByPageIndex(pageIndex: number): void;
/**
* Makes the specified text box active.
*/
setTextBoxSubDocumentAsActive(arg: number | FloatingTextBoxInfo): void;
/**
* Makes the specified sub-document active.
* @param id An integer value identifying the target sub-document by its id.
*/
setActiveSubDocumentById(id: number): boolean;
}
/**
* Defines a document's interval.
*/
declare class Interval {
/**
* Gets the interval's start position in the document.
*/
start: number;
/**
* Gets the interval's character length.
*/
length: number;
/**
* Initiates a new Interval object instance with the specified settings.
* @param start The interval's start position.
* @param length The interval's length.
*/
constructor(start?: number, length?: number);
}
/**
* Defines a simple state common to most of the client commands.
*/
declare class SimpleCommandState {
/**
* Specifies a command availability.
*/
enabled: boolean;
/**
* Specifies a command visibility.
*/
visible: boolean;
}
/**
* Defines the state of a command.
*/
declare class CommandState extends SimpleCommandState {
/**
* Specifies a command value.
*/
value: T;
}
/**
* Serves as a base for objects that implement different client command functionalities.
*/
declare class CommandBase {
}
/**
* Serves as a base for objects that implement different dialog-related client command functionalities.
*/
declare class CommandDialogBase extends CommandBase {
}
/**
* Serves as a base for commands with a simple common command state.
*/
declare abstract class CommandWithSimpleStateBase extends CommandBase {
/**
* Gets information about the command's state.
*/
abstract getState(): SimpleCommandState;
}
/**
* Serves as a base for dialog-related commands with a simple common command state.
*/
declare abstract class CommandWithSimpleStateDialogBase {
/**
* Gets information about the command's state.
*/
abstract getState(): SimpleCommandState;
}
/**
* Serves as a base for commands with the Boolean state.
*/
declare abstract class CommandWithBooleanStateBase extends CommandBase {
/**
* Gets information about the command's state.
*/
abstract getState(): CommandState;
}
/**
* A command to invoke the Bookmark dialog.
*/
declare class OpenInsertBookmarkDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenInsertBookmarkDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a new bookmark that references the current selection.
*/
declare class InsertBookmarkCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertBookmarkCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param name A string value specifying a name of the created bookmark.
* @param start An integer value specifying the start position of the bookmark's range.
* @param length An integer value specifying the length of the bookmark's range.
*/
execute(name: string, start: number, length: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete a specific bookmark.
*/
declare class DeleteBookmarkCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteBookmarkCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param name A string value specifying a name of the deleted bookmark.
*/
execute(name: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Gets a command to navigate to the specified bookmark in the document.
*/
declare class GoToBookmarkCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToBookmarkCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param name A string value specifying the bookmark's name
*/
execute(name: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to paste the text from the clipboard over the selection.
*/
declare class PasteCommand extends CommandWithSimpleStateBase {
/**
* Executes the PasteCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to copy the selected text and place it to the clipboard.
*/
declare class CopyCommand extends CommandWithSimpleStateBase {
/**
* Executes the CopyCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to cut the selected text and place it to the clipboard.
*/
declare class CutCommand extends CommandWithSimpleStateBase {
/**
* Executes the CutCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert an empty document field at the current position in the document.
*/
declare class CreateFieldCommand extends CommandWithSimpleStateBase {
/**
* Executes the CreateFieldCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param code A string value specifying the field code receiving to the created field.
*/
execute(code?: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to update the field's result.
*/
declare class UpdateFieldCommand extends CommandWithSimpleStateBase {
/**
* Executes the UpdateFieldCommand command. true if the command has been successfully executed; false if the command execution has failed.
* @param callback A callback function that is performed when updating of all fields in the selection is completed.
*/
execute(callback?: () => void): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to display the selected field's field codes.
*/
declare class ShowFieldCodesCommand extends CommandWithSimpleStateBase {
/**
* Executes the ShowFieldCodesCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param showFieldCodes true to display field codes, false to hide field codes.
*/
execute(showFieldCodes?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to display all field codes in place of the fields in the document.
*/
declare class ShowAllFieldCodesCommand extends CommandWithSimpleStateBase {
/**
* Executes the ShowAllFieldCodesCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param showFieldCodes true to display field codes, false to hide field codes.
*/
execute(showFieldCodes?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to update all fields in the selected range.
*/
declare class UpdateAllFieldsCommand extends CommandWithSimpleStateBase {
/**
* Executes the UpdateAllFieldsCommand command. true if the command has been successfully executed; false if the command execution has failed.
* @param callback A callback function that is performed when updating of all fields in the document is completed.
*/
execute(callback?: () => void): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a DATE field displaying the current date.
*/
declare class CreateDateFieldCommand extends CommandWithSimpleStateBase {
/**
* Executes the CreateDateFieldCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a TIME field displaying the current time.
*/
declare class CreateTimeFieldCommand extends CommandWithSimpleStateBase {
/**
* Executes the CreateTimeFieldCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a PAGE field displaying the current page number.
*/
declare class CreatePageFieldCommand extends CommandWithSimpleStateBase {
/**
* Executes the CreatePageFieldCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a caption for a figure.
*/
declare class InsertFiguresCaptionCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertFiguresCaptionCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a caption for a table.
*/
declare class InsertTablesCaptionCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTablesCaptionCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a caption for an equation.
*/
declare class InsertEquationsCaptionCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertEquationsCaptionCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to create a table of figures.
*/
declare class InsertTableOfFiguresCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableOfFiguresCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to create a table of tables.
*/
declare class InsertTableOfTablesCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableOfTablesCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to create a table of equations.
*/
declare class InsertTableOfEquationsCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableOfEquationsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a table of contents.
*/
declare class InsertTableOfContentsCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableOfContentsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to update a table of contents.
*/
declare class UpdateTableOfContentsCommand extends CommandWithSimpleStateBase {
/**
* Executes the UpdateTableOfContentsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the next data record of the bound data source.
*/
declare class GoToDataRecordCommand extends CommandBase {
/**
* Executes the GoToDataRecordCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param activeRecordIndex An integer value specifying index of the next data record.
*/
execute(activeRecordIndex: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* Contains the settings defining a data record.
*/
declare class DataRecordOptions {
/**
* Gets or sets the index of the active data record.
*/
activeRecordIndex: number;
/**
* Gets or sets the count of data source records.
*/
recordCount: number;
}
/**
* A command to navigate to the first data record of the bound data source.
*/
declare class GoToFirstDataRecordCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToFirstDataRecordCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the previous data record of the bound data source.
*/
declare class GoToPreviousDataRecordCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToPreviousDataRecordCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the next data record of the bound data source.
*/
declare class GoToNextDataRecordCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToNextDataRecordCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the last data record of the bound data source.
*/
declare class GoToLastDataRecordCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToLastDataRecordCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to display or hide actual data in MERGEFIELD fields.
*/
declare class ShowMergedDataCommand extends CommandWithBooleanStateBase {
/**
* Executes the ShowMergedDataCommand command. true if the command has been successfully executed; false if the command execution has failed.
*/
execute(showMergedData?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to invoke the Insert Merge Field dialog.
*/
declare class MergeFieldDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the MergeFieldDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a MERGEFIELD field (with a data source column name) at the current position in the document.
*/
declare class CreateMergeFieldCommand extends CommandWithSimpleStateBase {
/**
* Executes the CreateMergeFieldCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fieldName A string value specifying the name of the merge field.
*/
execute(fieldName: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Gets a command to invoke the Export Range dialog to start a mail merge.
*/
declare class MailMergeDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the MailMergeDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to start the mail merge process and download the resulting document containing the merged information.
*/
declare class MailMergeAndDownloadCommand {
/**
* Executes the MailMergeAndDownloadCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param fileExtension A string value specifying the file extension of the resulting document.
* @param settings A MailMergeSettings object containing settings to set up mail merge operations.
*/
execute(fileExtension: string | DocumentFormat, settings?: MailMergeSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to start the mail merge process and save the resulting merged document to the server.
*/
declare class MailMergeAndSaveAsCommand {
/**
* Executes the MailMergeAndSaveAsCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param filePath The path to a saved file, or an object that contains the saved file information.
* @param settings An object that contains settings to set up the mail merge operation.
*/
execute(filePath: string | RichEditFileInfo, settings?: MailMergeSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to insert a NUMPAGES field displaying the total number of pages.
*/
declare class CreatePageCountFieldCommand extends CommandWithSimpleStateBase {
/**
* Executes the CreatePageCountFieldCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Contains settings to set up mail merge operations.
*/
declare class MailMergeSettings {
/**
* Specifies which data rows should be exported into a merged document.
*/
range: MailMergeExportRange;
/**
* Gets or sets the index of the row from which the exported range starts.
*/
exportFrom: number;
/**
* Gets or sets the number of data rows in the exported mail-merge range.
*/
exportRecordsCount: number;
/**
* Gets or sets the merge mode.
*/
mergeMode: MergeMode;
}
/**
* Lists delimiters that start the new merged range.
*/
declare enum MergeMode {
/**
* Specifies that the next merged range starts with a new paragraph.
*/
NewParagraph = 0,
/**
* Specifies that the next merged range starts with a new section. The section break type is obtained from the previous section break or set to the NextPage by default. For headers and footers, it is the only allowed option.
*/
NewSection = 1,
/**
* Enables you to join rows, which result from a mail merge involving a table with merged fields, into a whole table.
*/
JoinTables = 2
}
/**
* Lists values that specify the range for mail-merge document export.
*/
declare enum MailMergeExportRange {
/**
* Specifies that all data source records will be included into the exported merged document.
*/
AllRecords = 0,
/**
* Specifies that only the current data source record will be included into the exported merged document.
*/
CurrentRecord = 1,
/**
* Specifies that a specific range of data source records will be included into the exported merged document.
*/
Range = 2
}
/**
* A command to create a new empty document.
*/
declare class FileNewCommand extends CommandWithSimpleStateBase {
/**
* Executes the FileNewCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to open the file, specifying its path.
*/
declare class FileOpenCommand {
/**
* Executes the FileOpenCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param path A string value specifying path to the opening file.
*/
execute(path: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the File Open dialog allowing one to select and load a document file into RichEdit.
*/
declare class FileOpenDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the FileOpenDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to save the document to a file.
*/
declare class FileSaveCommand extends CommandWithSimpleStateBase {
/**
* Executes the FileSaveCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* 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.
*/
declare class FileSaveAsCommand {
/**
* Executes the FileSaveAsCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
*/
execute(path: string | RichEditFileInfo): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to download the document file, specifying its extension.
*/
declare class FileDownloadCommand extends CommandWithSimpleStateBase {
/**
* Executes the FileDownloadCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fileExtension A string value specifying the extension of the downloading file.
*/
execute(fileExtension: string | DocumentFormat): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to open the file's Save As dialog.
*/
declare class FileSaveAsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the FileSaveAsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke a browser-specific Print dialog allowing one to print the current document.
*/
declare class FilePrintCommand extends CommandWithSimpleStateBase {
/**
* Executes the FilePrintCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Search Panel allowing end-users to search text and navigate through search results.
*/
declare class OpenFindPanelCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenFindPanelCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Find and Replace dialog.
*/
declare class OpenFindAndReplaceDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenFindAndReplaceDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to find all matches of the specified text in the document.
*/
declare class FindAllCommand extends CommandWithSimpleStateBase {
/**
* Executes the FindAllCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @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 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;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to hide the search results.
*/
declare class HideFindResultsCommand extends CommandWithSimpleStateBase {
/**
* Executes the HideFindResultsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to search for a specific text and replace all matches in the document with the specified string.
*/
declare class ReplaceAllCommand extends CommandWithSimpleStateBase {
/**
* Executes the ReplaceAllCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @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;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to search for a specific text and replace the next match in the document with the specified string.
*/
declare class ReplaceNextCommand extends CommandWithSimpleStateBase {
/**
* Executes the ReplaceNextCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @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;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Layout dialog.
*/
declare class OpenLayoutOptionsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenLayoutOptionsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a floating text box.
*/
declare class InsertFloatingTextBoxCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertFloatingTextBoxCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A base class for commands that modify floating object settings.
*/
declare class ChangeFloatingObjectPropertyCommandBase {
/**
* Executes a command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings An object that contains settings for the execute method.
*/
execute(settings: T): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to lock a floating object's anchor.
*/
declare class ChangeFloatingObjectLockAnchorCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeFloatingObjectLockAnchorCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param lockAnchor true to lock the anchor; false, otherwise.
*/
execute(lockAnchor: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a floating object's alignment position.
*/
declare class ChangeFloatingObjectAlignmentPositionCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeFloatingObjectAlignmentPositionCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A FloatingObjectAlignmentPositionSettings object specifying alignment position settings.
*/
execute(settings: FloatingObjectAlignmentPositionSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change a floating object's absolute position.
*/
declare class ChangeFloatingObjectAbsolutePositionCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeFloatingObjectAbsolutePositionCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A FloatingObjectAbsolutePositionSettings object specifying object position settings.
*/
execute(settings: FloatingObjectAbsolutePositionSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a floating object's relative position.
*/
declare class ChangeFloatingObjectRelativePositionCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeFloatingObjectRelativePositionCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A FloatingObjectRelativePositionSettings object specifying relative positioin settings.
*/
execute(settings: FloatingObjectRelativePositionSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a floating object's text wrapping settings.
*/
declare class ChangeFloatingObjectTextWrappingCommand {
/**
* Executes the ChangeFloatingObjectTextWrappingCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A FloatingObjectTextWrappingSettings object specifying text wrapping settings.
*/
execute(settings: FloatingObjectTextWrappingSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change a floating object's absolute size.
*/
declare class ChangeFloatingObjectAbsoluteSizeCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeFloatingObjectAbsoluteSizeCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A FloatingObjectAbsoluteSizeSettings object specifying absolute size settings.
*/
execute(settings: FloatingObjectAbsoluteSizeSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a text box' relative size settings.
*/
declare class ChangeTextBoxRelativeSizeCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeTextBoxRelativeSizeCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A TextBoxRelativeSizeSettings object specifying relative size settings.
*/
execute(settings: TextBoxRelativeSizeSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to rotate a floating object.
*/
declare class ChangeFloatingObjectRotationCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeFloatingObjectRotationCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param rotation An integer value specifying the angle of rotation.
*/
execute(rotation: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to lock a floating object's aspect ratio.
*/
declare class ChangeFloatingObjectLockAspectRatioCommand extends ChangeFloatingObjectPropertyCommandBase {
/**
* Executes the ChangeFloatingObjectLockAspectRatioCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param lockAspectRatio true to lock the aspect ratio and maintain the proportions; otherwise, false.
*/
execute(lockAspectRatio: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a floating object's background fill color.
*/
declare class ChangeFloatingObjectFillColorCommand extends CommandBase {
/**
* Executes the ChangeFloatingObjectFillColorCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param color A string value specifying the color.
*/
execute(color: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a floating object's outline color.
*/
declare class ChangeFloatingObjectOutlineColorCommand extends CommandBase {
/**
* Executes the ChangeFloatingObjectOutlineColorCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param color A string value specifying the color.
*/
execute(color: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a floating object's outline width.
*/
declare class ChangeFloatingObjectOutlineWidthCommand extends CommandBase {
/**
* Executes the ChangeFloatingObjectOutlineWidthCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param width An integer value specifying the outline width.
*/
execute(width: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to modify a text box' content margins.
*/
declare class ChangeTextBoxContentMarginsCommand extends CommandBase {
/**
* Executes the ChangeTextBoxContentMarginsCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A Margins object specifying margin settings.
*/
execute(settings: Margins): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to resize the shape to fit the text in the text box.
*/
declare class ChangeTextBoxResizeShapeToFitTextCommand extends CommandBase {
/**
* Executes the ChangeTextBoxResizeShapeToFitTextCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param resizeShapeToFitText true, to resize the shape to fit the text; otherwise, false.
*/
execute(resizeShapeToFitText: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* Contains alignment position settings for floating objects.
*/
declare class FloatingObjectAlignmentPositionSettings {
/**
* Gets or sets a value specifying how a floating object is horizontally aligned relative to an element specified by the FloatingObjectAlignmentPositionSettings.horizontalPositionAlignment property.
*/
horizontalPositionAlignment: FloatingObjectHorizontalPositionAlignment;
/**
* Gets or sets a value specifying to what element the horizontal alignment of a floating object is relative.
*/
horizontalPositionType: FloatingObjectHorizontalPositionType;
/**
* Gets or sets a value specifying how a floating object is vertically aligned relative to an element specified by the FloatingObjectAlignmentPositionSettings.verticalPositionAlignment property.
*/
verticalPositionAlignment: FloatingObjectVerticalPositionAlignment;
/**
* Gets or sets a value specifying to what element the vertical alignment of a floating object is relative.
*/
verticalPositionType: FloatingObjectVerticalPositionType;
}
/**
* Contains page margin settings.
*/
declare class FloatingObjectAbsolutePositionSettings {
/**
* Gets or sets a floating object's horizontal position relative to an element specified by the FloatingObjectAbsolutePositionSettings.horizontalPositionType property.
*/
horizontalAbsolutePosition: number;
/**
* Gets or sets a value specifying to what element the horizontal position of a floating object is relative.
*/
horizontalPositionType: FloatingObjectHorizontalPositionType;
/**
* Gets or sets a floating object's vertical position relative to an element specified by the FloatingObjectAbsolutePositionSettings.verticalPositionType property.
*/
verticalAbsolutePosition: number;
/**
* Gets or sets a value specifying to what element the vertical position of a floating object is relative.
*/
verticalPositionType: FloatingObjectVerticalPositionType;
}
/**
* Contains relative position settings for floating objects.
*/
declare class FloatingObjectRelativePositionSettings {
/**
* Gets or sets the horizontal distance between the edge of a floating object and the element specified by the FloatingObjectRelativePositionSettings.horizontalRelativePosition property
*/
horizontalRelativePosition: number;
/**
* Gets or sets a value specifying to what element the horizontal position of a floating object is relative.
*/
horizontalPositionType: FloatingObjectHorizontalPositionType;
/**
* Gets or sets the horizontal distance between the edge of a floating object and the element specified by the FloatingObjectRelativePositionSettings.verticalRelativePosition property
*/
verticalRelativePosition: number;
/**
* Gets or sets a value specifying to what element the vertical position of a floating object is relative.
*/
verticalPositionType: FloatingObjectVerticalPositionType;
}
/**
* Contains text wrapping settings for floating objects.
*/
declare class FloatingObjectTextWrappingSettings {
/**
* Gets or sets a value specifying how text is wrapped around a floating object.
*/
floatingObjectTextWrapType: FloatingObjectTextWrapType;
/**
* Gets or sets a value specifying how text can wrap around a floating object's left and right sides.
*/
floatingObjectTextWrapSide: FloatingObjectTextWrapSide;
/**
* Gets or sets the left offset of text wrapping.
*/
leftDistance: number;
/**
* Gets or sets the right offset of text wrapping.
*/
rightDistance: number;
/**
* Gets or sets the top offset of text wrapping.
*/
topDistance: number;
/**
* Gets or sets the bottom offset of text wrapping.
*/
bottomDistance: number;
}
/**
* Contains absolute size settings for floating objects.
*/
declare class FloatingObjectAbsoluteSizeSettings {
/**
* Gets or sets a floating object's absolute width.
*/
absoluteWidth: number;
/**
* Gets or sets a floating object's absolute height.
*/
absoluteHeight: number;
}
/**
* Contains relative size settings for floating objects.
*/
declare class TextBoxRelativeSizeSettings {
/**
* Gets or sets the percentage specifying a floating object's width relative to the element defined by the TextBoxRelativeSizeSettings.relativeWidthType property.
*/
relativeWidth: number;
/**
* Gets or sets a value specifying to what element the floating object width is relative.
*/
relativeWidthType: FloatingObjectRelativeWidthType;
/**
* Gets or sets the percentage specifying a floating object's height relative to the element defined by the TextBoxRelativeSizeSettings.relativeHeightType property.
*/
relativeHeight: number;
/**
* Gets or sets a value specifying to what element the floating object height is relative.
*/
relativeHeightType: FloatingObjectRelativeHeightType;
}
/**
* Lists values specifying to what element the floating object width is relative.
*/
declare enum FloatingObjectRelativeWidthType {
/**
* Relative to margin.
*/
Margin = 0,
/**
* Relative to page.
*/
Page = 1,
/**
* Relative to left margin.
*/
LeftMargin = 2,
/**
* Relative to right margin.
*/
RightMargin = 3,
/**
* Relative to inside margin.
*/
InsideMargin = 4,
/**
* Relative to outside margin.
*/
OutsideMargin = 5
}
/**
* Lists values specifying to what element the floating object height is relative.
*/
declare enum FloatingObjectRelativeHeightType {
/**
* Relative to margin.
*/
Margin = 0,
/**
* Relative to page.
*/
Page = 1,
/**
* Relative to top margin.
*/
TopMargin = 2,
/**
* Relative to bottom margin.
*/
BottomMargin = 3,
/**
* Relative to inside margin.
*/
InsideMargin = 4,
/**
* Relative to outside margin.
*/
OutsideMargin = 5
}
/**
* Lists values specifying how text is wrapped around a floating object.
*/
declare enum FloatingObjectTextWrapType {
/**
* The text does not wrap around the shape.
*/
None = 0,
/**
* The text is displayed above and below the shape and does not wrap around the sides.
*/
TopAndBottom = 1,
/**
* The text wraps tightly around the shape.
*/
Tight = 2,
/**
* The text wraps tightly around the shape and can fill in the transparent background space inside the shape.
*/
Through = 3,
/**
* The text wraps around the rectangular borders of the shape.
*/
Square = 4
}
/**
* Lists values specifying how text can wrap around a floating object's left and right sides.
*/
declare enum FloatingObjectTextWrapSide {
/**
* Wraps text to both the left and right of the shape.
*/
Both = 0,
/**
* Wraps text to the left of the shape.
*/
Left = 1,
/**
* Wraps text to the right of the shape.
*/
Right = 2,
/**
* Wraps text on the side that is the greater distance from the shape to the margin.
*/
Largest = 3
}
/**
* Lists values specifying to what element the horizontal position of a floating object is relative.
*/
declare enum FloatingObjectHorizontalPositionType {
/**
* Relative to page.
*/
Page = 0,
/**
* Relative to character.
*/
Character = 1,
/**
* Relative to column.
*/
Column = 2,
/**
* Relative to margin.
*/
Margin = 3,
/**
* Relative to left margin.
*/
LeftMargin = 4,
/**
* Relative to right margin.
*/
RightMargin = 5,
/**
* Relative to inside margin.
*/
InsideMargin = 6,
/**
* Relative to outside margin.
*/
OutsideMargin = 7
}
/**
* Lists values specifying how a floating object is horizontally aligned relative to the specified element.
*/
declare enum FloatingObjectHorizontalPositionAlignment {
/**
* The shape is not horizontally aligned.
*/
None = 0,
/**
* The shape is left-aligned relative to its FloatingObjectAlignmentPositionSettings.horizontalPositionType.
*/
Left = 1,
/**
* The shape is centered relative to its FloatingObjectAlignmentPositionSettings.horizontalPositionType.
*/
Center = 2,
/**
* The shape is right-aligned relative to its FloatingObjectAlignmentPositionSettings.horizontalPositionType.
*/
Right = 3,
/**
* The shape is aligned inside relative to its FloatingObjectAlignmentPositionSettings.horizontalPositionType.
*/
Inside = 4,
/**
* The shape is aligned outside relative to its FloatingObjectAlignmentPositionSettings.horizontalPositionType.
*/
Outside = 5
}
/**
* Lists values specifying to what element the vertical position of a floating object is relative.
*/
declare enum FloatingObjectVerticalPositionType {
/**
* Relative to page.
*/
Page = 0,
/**
* Relative to line.
*/
Line = 1,
/**
* Relative to paragraph.
*/
Paragraph = 2,
/**
* Relative to margin.
*/
Margin = 3,
/**
* Relative to top margin.
*/
TopMargin = 4,
/**
* Relative to bottom margin.
*/
BottomMargin = 5,
/**
* Relative to inside margin.
*/
InsideMargin = 6,
/**
* Relative to outside margin.
*/
OutsideMargin = 7
}
/**
* Lists values specifying how a floating object is vertically aligned relative to the specified element.
*/
declare enum FloatingObjectVerticalPositionAlignment {
/**
* The shape is not vertically aligned.
*/
None = 0,
/**
* The shape is top aligned relative to its FloatingObjectAlignmentPositionSettings.verticalPositionType.
*/
Top = 1,
/**
* The shape is centered relative to its FloatingObjectAlignmentPositionSettings.verticalPositionType.
*/
Center = 2,
/**
* The shape is aligned to the bottom relative to its FloatingObjectAlignmentPositionSettings.verticalPositionType.
*/
Bottom = 3,
/**
* The shape is aligned inside relative to its FloatingObjectAlignmentPositionSettings.verticalPositionType.
*/
Inside = 4,
/**
* The shape is aligned outside relative to its FloatingObjectAlignmentPositionSettings.verticalPositionType.
*/
Outside = 5
}
/**
* A command to cancel changes caused by the previous command.
*/
declare class UndoCommand extends CommandWithSimpleStateBase {
/**
* Executes the UndoCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to reverse actions of the previous undo command.
*/
declare class RedoCommand extends CommandWithSimpleStateBase {
/**
* Executes the RedoCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to add an HTML formatted content in place of a selected range.
*/
declare class InsertHtmlCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertHtmlCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param html A string that specifies the inserted HTML code.
*/
execute(html: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Hyperlink dialog.
*/
declare class OpenInsertHyperlinkDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenInsertHyperlinkDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a hyperlink at the current position in the document.
*/
declare class InsertHyperlinkCommand {
/**
* Executes the InsertHyperlinkCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A HyperlinkSettings object specifying hyperlink settings.
*/
execute(settings: HyperlinkSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to delete the selected hyperlink.
*/
declare class DeleteHyperlinkCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteHyperlinkCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete all hyperlinks in a selected range.
*/
declare class DeleteHyperlinksCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteHyperlinksCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the document bookmark or URI (uniform resource identifier) specified for the hyperlink.
*/
declare class OpenHyperlinkCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenHyperlinkCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the specified hyperlink.
*/
declare class ChangeHyperlinkCommand extends CommandWithSimpleStateBase {
/**
* Executes the ChangeHyperlinkCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param fieldIndex An integer value specifying the field's index in the specified sub-document.
* @param hyperlinkSettings An object specifying the hyperlink's properties.
* @param subDocumentId A nullable value specifying the sub-document.
*/
execute(fieldIndex: number, hyperlinkSettings: HyperlinkSettings, subDocumentId?: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Contains settings to define a hyperlink.
*/
declare class HyperlinkSettings {
/**
* Specifies a hyperlink text.
*/
text: string;
/**
* Specifies a tooltip text.
*/
tooltip: string;
/**
* Specifies a hyperlink's destination.
*/
url: string;
/**
* Specifies a hyperlink's bookmark.
*/
bookmark: string;
/**
* Initializes a new instance of the HyperlinkSettings object.
* @param url A hyperlink URL.
* @param bookmark A bookmark name.
* @param tooltip A tooltip text.
* @param text A hyperlink text.
*/
constructor(url?: string, bookmark?: string, tooltip?: string, text?: string);
}
/**
* A command to insert a page break at the current position in the document.
*/
declare class InsertPageBreakCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertPageBreakCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a column break at the current position in the document.
*/
declare class InsertColumnBreakCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertColumnBreakCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a section break and start a new section on the next page.
*/
declare class InsertSectionBreakNextPageCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertSectionBreakNextPageCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a section break and start a new section on the next even-numbered page.
*/
declare class InsertSectionBreakEvenPageCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertSectionBreakEvenPageCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a section break and start a new section on the next odd-numbered page.
*/
declare class InsertSectionBreakOddPageCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertSectionBreakOddPageCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert the line break at the current position in the document.
*/
declare class InsertLineBreakCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertLineBreakCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to increment the indent level of paragraphs in a selected range.
*/
declare class IncreaseIndentCommand extends CommandWithSimpleStateBase {
/**
* Executes the IncreaseIndentCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to decrement the indent level of paragraphs in a selected range.
*/
declare class DecreaseIndentCommand extends CommandWithSimpleStateBase {
/**
* Executes the DecreaseIndentCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to toggle the visibility of hidden symbols.
*/
declare class ShowHiddenSymbolsCommand extends CommandWithBooleanStateBase {
/**
* Executes the ShowHiddenSymbolsCommand command. true if the command has been successfully executed; false if the command execution has failed.
* @param show true, to show hidden symbols; otherwise, false.
*/
execute(show?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle left paragraph alignment on and off.
*/
declare class ToggleParagraphAlignmentLeftCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleParagraphAlignmentLeftCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle centered paragraph alignment on and off.
*/
declare class ToggleParagraphAlignmentCenterCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleParagraphAlignmentCenterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle right paragraph alignment on and off.
*/
declare class ToggleParagraphAlignmentRightCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleParagraphAlignmentRightCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle justified paragraph alignment on and off.
*/
declare class ToggleParagraphAlignmentJustifyCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleParagraphAlignmentJustifyCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to format a current paragraph with single line spacing.
*/
declare class SetSingleParagraphSpacingCommand extends CommandWithBooleanStateBase {
/**
* Executes the SetSingleParagraphSpacingCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to format a current paragraph with one and a half line spacing.
*/
declare class SetSesquialteralParagraphSpacingCommand extends CommandWithBooleanStateBase {
/**
* Executes the SetSesquialteralParagraphSpacingCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to format a current paragraph with double line spacing.
*/
declare class SetDoubleParagraphSpacingCommand extends CommandWithBooleanStateBase {
/**
* Executes the SetDoubleParagraphSpacingCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to add spacing before a paragraph.
*/
declare class AddSpacingBeforeParagraphCommand extends CommandWithSimpleStateBase {
/**
* Executes the AddSpacingBeforeParagraphCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to add spacing after a paragraph.
*/
declare class AddSpacingAfterParagraphCommand extends CommandWithSimpleStateBase {
/**
* Executes the AddSpacingAfterParagraphCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to remove spacing before the selected paragraph.
*/
declare class RemoveSpacingBeforeParagraphCommand extends CommandWithSimpleStateBase {
/**
* Executes the RemoveSpacingBeforeParagraphCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to remove spacing after the selected paragraph.
*/
declare class RemoveSpacingAfterParagraphCommand extends CommandWithSimpleStateBase {
/**
* Executes the RemoveSpacingAfterParagraphCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the background color of paragraphs in a selected range.
*/
declare class ChangeParagraphBackColorCommand extends CommandBase {
/**
* Executes the ChangeParagraphBackColorCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param color A string specifying a background color of the paragraphs in a selected range. May be specified as a color name or a hex color value.
*/
execute(color: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to invoke the Paragraph dialog allowing end-users to set paragraph formatting.
*/
declare class OpenParagraphFormattingDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenParagraphFormattingDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the formatting of paragraphs in a selected range.
*/
declare class ChangeParagraphFormattingCommand extends CommandBase {
/**
* Executes the ChangeParagraphFormattingCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A ParagraphFormattingSettings object specifying paragraph formatting settings.
*/
execute(settings: ParagraphFormattingSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to increment the left indentation of paragraphs in a selected range.
*/
declare class IncrementParagraphLeftIndentCommand extends CommandBase {
/**
* Executes the IncrementParagraphLeftIndentCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to decrement the left indentation of paragraphs in a selected range.
*/
declare class DecrementParagraphLeftIndentCommand extends CommandWithSimpleStateBase {
/**
* Executes the DecrementParagraphLeftIndentCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Tabs paragraph dialog.
*/
declare class OpenTabsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenTabsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change paragraph tab stops.
*/
declare class ChangeTabsCommand {
/**
* Executes the ChangeTabsCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A TabsSettings object maintaining the information about tab stops.
*/
execute(settings: TabsSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply a paragraph level to the selected text
*/
declare class SetParagraphLevelCommand extends CommandBase {
/**
* Executes the SetParagraphLevelCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param level An integer value specifying the applied style. The value should be in the range from 0 to 9.
*/
execute(level: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* Contains the information about tab stops.
*/
declare class TabsSettings {
/**
* Specifies the default distance between tab stops.
*/
defaultTabStop: number;
/**
* Gets or sets a list of tab stops.
*/
tabs: TabSettings[];
}
/**
* Contains settings of a tab stop.
*/
declare class TabSettings {
/**
* Specifies the tab alignment type.
*/
alignment: TabAlign;
/**
* Specifies the tab leader symbol.
*/
leader: TabLeaderType;
/**
* Specifies the position of the tab stop.
*/
position: number;
/**
* Specifies whether the individual tab stop is in effect.
*/
deleted: boolean;
}
/**
* List alignment types for tab stops.
*/
declare enum TabAlign {
/**
* Text is left aligned with the tab stop.
*/
Left = 0,
/**
* Text is centered on the tab stop.
*/
Center = 1,
/**
* Text is right aligned with the tab stop.
*/
Right = 2,
/**
* The decimal point is located at the tab stop.
*/
Decimal = 3,
/**
* For internal use only.
*/
Numbering = 4
}
/**
* Lists repeated characters used to fill in the space created by a tab which ends at the tab stop.
*/
declare enum TabLeaderType {
/**
* No leader characters are used.
*/
None = 0,
/**
* The dot is used as a tab leader character.
*/
Dots = 1,
/**
* The middle dot (interpunct) is used as a tab leader character.
*/
MiddleDots = 2,
/**
* The hyphen is used as a tab leader character.
*/
Hyphens = 3,
/**
* The underscore is used as a tab leader character.
*/
Underline = 4,
/**
* The line is used as a tab leader character.
*/
ThickLine = 5,
/**
* The equal sign is used as a tab leader character.
*/
EqualSign = 6
}
/**
* Contains paragraph formatting settings.
*/
declare class ParagraphFormattingSettings {
/**
* Specifies the paragraph alignment.
*/
alignment: ParagraphAlignment;
/**
* Specifies the paragraph's outline level.
*/
outlineLevel: number;
/**
* Specifies the paragraph's right indent.
*/
rightIndent: number;
/**
* Specifies the spacing before the paragraph.
*/
spacingBefore: number;
/**
* Specifies the spacing after the paragraph.
*/
spacingAfter: number;
/**
* Specifies a spacing between lines in the paragraph.
*/
lineSpacingType: ParagraphLineSpacingType;
/**
* Specifies whether and how the paragraph's first line is indented.
*/
firstLineIndentType: ParagraphFirstLineIndent;
/**
* Specifies the indent of the paragraph's first line.
*/
firstLineIndent: number;
/**
* Specifies whether to remove an additional space (contextual spacing) between paragraphs of the same style.
*/
contextualSpacing: boolean;
/**
* Specifies whether all lines in a paragraph should appear on the same page.
*/
keepLinesTogether: boolean;
/**
* Specifies whether a page break is inserted before the paragraph.
*/
pageBreakBefore: boolean;
/**
* Specifies the left indent for text in a paragraph.
*/
leftIndent: number;
/**
* Specifies a line spacing value.
*/
lineSpacing: number;
/**
* Specifies the paragraph background color.
*/
backColor: string;
}
/**
* Lists values specifying the paragraph alignment.
*/
declare enum ParagraphAlignment {
/**
* Text is aligned to the left of the paragraph.
*/
Left = 0,
/**
* Text is aligned to the right of the paragraph.
*/
Right = 1,
/**
* Text is aligned to the center of the paragraph.
*/
Center = 2,
/**
* Text is justified to the entire width of the paragraph.
*/
Justify = 3
}
/**
* Lists values specifying the type of paragraph line spacing.
*/
declare enum ParagraphLineSpacingType {
/**
* This option accommodates the largest font in that line, plus a small amount of extra space. The amount of extra space varies depending on the font that is used.
*/
Single = 0,
/**
* This option is one-and-one-half times that of single line spacing.
*/
Sesquialteral = 1,
/**
* This option is twice that of single line spacing.
*/
Double = 2,
/**
* This option sets line spacing that can be expressed in numbers greater than 1. For example, setting line spacing to 1.15 will increase the space by 15 percent, and setting line spacing to 3 increases the space by 300 percent (triple spacing). The multiplication value is specified by the lineSpacing property.
*/
Multiple = 3,
/**
* This option sets fixed line spacing, specified by the ParagraphFormattingSettings.lineSpacing property.
*/
Exactly = 4,
/**
* The line spacing can be greater than or equal to, but never less than, the specified ParagraphFormattingSettings.lineSpacing value.
*/
AtLeast = 5
}
/**
* Lists values specifying the indent for the first line in a paragraph.
*/
declare enum ParagraphFirstLineIndent {
/**
* The first line of a paragraph doesn't have any indent.
*/
None = 0,
/**
* The first line of a paragraph is indented to the right by the value specified by the ParagraphFormattingSettings.firstLineIndent property.
*/
Indented = 1,
/**
* The first line of a paragraph is indented to the left, by the value specified by the ParagraphFormattingSettings.firstLineIndent property.
*/
Hanging = 2
}
/**
* A command to toggle between the bulleted paragraph and normal text.
*/
declare class ToggleBulletedListCommand extends CommandBase {
/**
* Executes the ToggleBulletedListCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle between the numbered paragraph and normal text.
*/
declare class ToggleNumberingListCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleNumberingListCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle between the multilevel list style and normal text.
*/
declare class ToggleMultilevelListCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleMultilevelListCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to invoke the Bulleted and Numbering dialog.
*/
declare class OpenNumberingListDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenNumberingListDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Customize Numbered List dialog.
*/
declare class OpenCustomNumberingListDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenCustomNumberingListDialogCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param abstractNumberingListIndex An integer value specifying index of abstract numbering list.
*/
execute(abstractNumberingListIndex: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to customize the numbered list parameters.
*/
declare class ChangeCustomNumberingListCommand {
/**
* Executes the ChangeCustomNumberingListCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param abstractNumberingListIndex An integer value specifying the numbering list index.
* @param listLevelSettings An array of ListLevelSettings objects defining settings for list levels.
*/
execute(abstractNumberingListIndex: number, listLevelSettings: ListLevelSettings[]): boolean;
/**
* Gets information about the command's state. An object that contains the command's state.
* @param abstractNumberingListIndex An integer value specifying the index of the abstract numbering list item whose state to return.
*/
getState(abstractNumberingListIndex: number): CommandState;
}
/**
* A command to restart the numbering list.
*/
declare class RestartNumberingListCommand extends CommandWithSimpleStateBase {
/**
* Executes the RestartNumberingListCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to increment the indent level of paragraphs in a selected numbered list.
*/
declare class IncrementNumberingIndentCommand extends CommandWithSimpleStateBase {
/**
* Executes the IncrementNumberingIndentCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to decrement the indent level of paragraphs in a selected numbered list.
*/
declare class DecrementNumberingIndentCommand extends CommandWithSimpleStateBase {
/**
* Executes the DecrementNumberingIndentCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to continue the list's numbering.
*/
declare class ContinueNumberingListCommand extends CommandWithSimpleStateBase {
/**
* Executes the ContinueNumberingListCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert numeration to a paragraph making it a numbering list item.
*/
declare class InsertNumerationCommand extends CommandWithSimpleStateBase {
/**
* Executes the ChangePageMarginsCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param numberingListIndex The list index.
* @param isAbstractNumberingList true, for abstract lists; otherwise, false.
*/
execute(numberingListIndex: number, isAbstractNumberingList?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to remove the selected numeration.
*/
declare class RemoveNumerationCommand extends CommandWithSimpleStateBase {
/**
* Executes the RemoveNumerationCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Contains settings to define individual bulleted or numbered list levels.
*/
declare class ListLevelSettings {
/**
* Gets or sets the pattern used to format the list level for display purposes.
*/
displayFormatString: string;
/**
* Gets or sets the numbering format used for the current list level's paragraph.
*/
format: ListLevelFormat;
/**
* Gets the list level item's start position in the document.
*/
start: number;
/**
* Gets or sets the paragraph text alignment within numbered list levels.
*/
alignment: ListLevelNumberAlignment;
/**
* Gets or sets the character inserted after the number for a numbered list item.
*/
separator: string;
/**
* Gets or sets the left indent for text within the current list level's paragraph.
*/
leftIndent: number;
/**
* Gets or sets a value specifying the indent of the first line of the current list level's paragraph.
*/
firstLineIndent: number;
/**
* Gets or sets a value specifying whether and how the first line of the current list level's paragraph is indented.
*/
firstLineIndentType: ParagraphFirstLineIndent;
/**
* Gets or sets the font name of the current list level's paragraph.
*/
fontName: string;
/**
* Gets or sets the font color of the current list level's paragraph.
*/
fontColor: string;
/**
* Gets or sets the font size of the current list level's paragraph.
*/
fontSize: number;
/**
* Gets or sets whether the font formatting of the current list level's paragraph is bold.
*/
fontBold: boolean;
/**
* Gets or sets whether the font formatting of the current list level's paragraph is italic.
*/
fontItalic: boolean;
}
/**
* Lists values that specify the numbering format used for a group of automatically numbered objects, such as pages.
*/
declare enum ListLevelFormat {
/**
* Specifies that the sequence shall consist of decimal numbering. Example: 1, 2, 3, ... , 9, 10, 11
*/
Decimal = 0,
/**
* Specifies that the sequence shall consist of hiragana characters in the traditional a-i-u-e-o order. Currently not supported.
*/
AIUEOHiragana = 1,
/**
* Specifies that the sequence shall consist of full-width hiragana characters in the traditional a-i-u-e-o order. Currently not supported.
*/
AIUEOFullWidthHiragana = 2,
/**
* Specifies that the sequence shall consist of ascending Abjad numerals. Currently not supported.
*/
ArabicAbjad = 3,
/**
* Specifies that the sequence shall consist of characters in the Arabic alphabet. Currently not supported.
*/
ArabicAlpha = 4,
/**
* Specifies that the sequence shall consist of bullet characters.
*/
Bullet = 5,
/**
* Specifies that the sequence shall consist of cardinal text of the current language. Example: one, two, three. The following languages are currently supported: English, French, German, Italian, Russian, Swedish and Turkish.
*/
CardinalText = 6,
/**
* Specifies that the sequence shall consist of characters as defined in the Chicago Manual of Style. Currently not supported.
*/
Chicago = 7,
/**
* Specifies that the sequence shall consist of ascending numbers from the Chinese counting system. Currently not supported.
*/
ChineseCounting = 8,
/**
* Specifies that the sequence shall consist of sequential numbers from the Chinese counting thousand system. Currently not supported.
*/
ChineseCountingThousand = 9,
/**
* Specifies that the sequence shall consist of sequential numbers from the Chinese simplified legal format. Currently not supported.
*/
ChineseLegalSimplified = 10,
/**
* Specifies that the sequence shall consist of sequential numbers from the Korean Chosung format. Currently not supported.
*/
Chosung = 11,
/**
* Specifies that the sequence shall consist of decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character. Once the specified sequence reaches 21, the numbers may be replaced with non-enclosed equivalents. Currently not supported.
*/
DecimalEnclosedCircle = 12,
/**
* Specifies that the sequence shall consist of decimal numbering enclosed in a circle, using the enclosed alphanumeric glyph character. Currently not supported.
*/
DecimalEnclosedCircleChinese = 13,
/**
* Specifies that the sequence shall consist of decimal numbering followed by a period, using the enclosed alphanumeric glyph character. Currently not supported.
*/
DecimalEnclosedFullstop = 14,
/**
* Specifies that the sequence shall consist of decimal numbering enclosed in parentheses.
*/
DecimalEnclosedParentheses = 15,
/**
* Specifies that the sequence shall consist of double-byte Arabic numbering. Currently not supported.
*/
DecimalFullWidth = 16,
/**
* Specifies that the sequence shall consist of an alternative set of double-byte Arabic numbering, if one exists in the current font. Currently not supported.
*/
DecimalFullWidth2 = 17,
/**
* Specifies that the sequence shall consist of single-byte Arabic numbering. Example: 1, 2, 3
*/
DecimalHalfWidth = 18,
/**
* Specifies that the sequence shall consist of Arabic numbering with a zero added to numbers one through nine. Example: 01, 02, 03, ..., 09, 10
*/
DecimalZero = 19,
/**
* Specifies that the sequence shall consist of sequential numbers from the Korean Ganada format. Currently not supported.
*/
Ganada = 20,
/**
* Specifies that the sequence shall consist of Hebrew numerals. Currently not supported.
*/
Hebrew1 = 21,
/**
* Specifies that the sequence shall consist of the Hebrew alphabet. Currently not supported.
*/
Hebrew2 = 22,
/**
* Specifies that the sequence shall consist of hexadecimal numbering. Example: 1, 2, 3, ... , 9, A, B
*/
Hex = 23,
/**
* Specifies that the sequence shall consist of Hindi consonants. Currently not supported.
*/
HindiConsonants = 24,
/**
* Specifies that the sequence shall consist of sequential numbers from the Hindi counting system. Currently not supported.
*/
HindiDescriptive = 25,
/**
* Specifies that the sequence shall consist of Hindi numbers. Currently not supported.
*/
HindiNumbers = 26,
/**
* Specifies that the sequence shall consist of Hindi vowels. Currently not supported.
*/
HindiVowels = 27,
/**
* Specifies that the sequence shall consist of sequential numerical ideographs enclosed in a circle, using the appropriate character. Currently not supported.
*/
IdeographDigital = 28,
/**
* Specifies that the sequence shall consist of sequential numerical ideographs enclosed in a circle, using the appropriate character. Currently not supported.
*/
IdeographEnclosedCircle = 29,
/**
* Specifies that the sequence shall consist of traditional sequential numerical legal ideographs. Currently not supported.
*/
IdeographLegalTraditional = 30,
/**
* Specifies that the sequence shall consist of traditional sequential numerical ideographs. Currently not supported.
*/
IdeographTraditional = 31,
/**
* Specifies that the sequence shall consist of traditional sequential numerical ideographs. Currently not supported.
*/
IdeographZodiac = 32,
/**
* Specifies that the sequence shall consist of traditional sequential zodiac ideographs. Currently not supported.
*/
IdeographZodiacTraditional = 33,
/**
* Specifies that the sequence shall consist of the iroha. Currently not supported.
*/
Iroha = 34,
/**
* Specifies that the sequence shall consist of the full-width forms of the iroha. Currently not supported.
*/
IrohaFullWidth = 35,
/**
* Specifies that the sequence shall consist of the full-width forms of the iroha. Currently not supported.
*/
JapaneseCounting = 36,
/**
* Specifies that the sequence shall consist of sequential numbers from the Japanese digital ten thousand counting system. Currently not supported.
*/
JapaneseDigitalTenThousand = 37,
/**
* Specifies that the sequence shall consist of sequential numbers from the Japanese legal counting system. Currently not supported.
*/
JapaneseLegal = 38,
/**
* Specifies that the sequence shall consist of sequential numbers from the Korean counting system. Currently not supported.
*/
KoreanCounting = 39,
/**
* Specifies that the sequence shall consist of sequential numbers from the Korean digital counting system. Currently not supported.
*/
KoreanDigital = 40,
/**
* Specifies that the sequence shall consist of sequential numbers from the Korean digital counting system. Currently not supported.
*/
KoreanDigital2 = 41,
/**
* Specifies that the sequence shall consist of sequential numbers from the Korean legal numbering system. Currently not supported.
*/
KoreanLegal = 42,
/**
* Specifies that the sequence shall consist of the letters of the Latin alphabet in lower case. Example: a, b, c
*/
LowerLetter = 43,
/**
* Specifies that the sequence shall consist of lowercase roman numerals. Example: i, ii, iii
*/
LowerRoman = 44,
/**
* Specifies the default numbering sequence (specifies that the sequence consists of decimal numbering).
*/
None = 45,
/**
* Specifies that the sequence shall consist of Arabic numbering surrounded by dash characters. Example: - 1 -, - 2 -, - 3 -
*/
NumberInDash = 46,
/**
* Specifies that the sequence shall consist of ordinals of the current language. Example: 1st, 2nd, 3rd. The following languages are currently supported: English, French, German, Italian, Russian, Swedish and Turkish.
*/
Ordinal = 47,
/**
* Specifies that the sequence shall consist of ordinal text of the current language. Example: first, second, third. The following languages are currently supported: English, French, German, Italian, Russian, Swedish and Turkish.
*/
OrdinalText = 48,
/**
* Specifies that the sequence shall consist of the letters of the Russian alphabet in lower case. Example: а, б, в
*/
RussianLower = 49,
/**
* Specifies that the sequence shall consist of the letters of the Russian alphabet in upper case. Example: А, Б, В
*/
RussianUpper = 50,
/**
* Specifies that the sequence shall consist of sequential numbers from the Taiwanese counting system. Currently not supported.
*/
TaiwaneseCounting = 51,
/**
* Specifies that the sequence shall consist of sequential numbers from the Taiwanese counting thousand system. Currently not supported.
*/
TaiwaneseCountingThousand = 52,
/**
* Specifies that the sequence shall consist of sequential numbers from the Taiwanese digital counting system. Currently not supported.
*/
TaiwaneseDigital = 53,
/**
* Specifies that the sequence shall consist of sequential numbers from the Thai counting system. Currently not supported.
*/
ThaiDescriptive = 54,
/**
* Specifies that the sequence shall consist of Thai letters. Currently not supported.
*/
ThaiLetters = 55,
/**
* Specifies that the sequence shall consist of Thai numerals. Currently not supported.
*/
ThaiNumbers = 56,
/**
* Specifies that the sequence shall consist of the letters of the Latin alphabet in upper case. Example: A, B, C
*/
UpperLetter = 57,
/**
* Specifies that the sequence shall consist of uppercase roman numerals. Example: I, II, III
*/
UpperRoman = 58,
/**
* Specifies that the sequence shall consist of Vietnamese numerals. Currently not supported.
*/
VietnameseDescriptive = 59
}
/**
* Lists values that specify the paragraph text alignment within numbered list levels.
*/
declare enum ListLevelNumberAlignment {
/**
* Text is aligned to the left of the list level's paragraph.
*/
Left = 0,
/**
* Text is aligned to the center of the list level's paragraph.
*/
Center = 1,
/**
* Text is aligned to the right of the list level's paragraph.
*/
Right = 2
}
/**
* A command to invoke the Insert Image dialog.
*/
declare class OpenInsertPictureDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenInsertPictureDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a picture from a file.
*/
declare class InsertPictureCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertPictureCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param imageUrl A string value specifying picture's Url.
*/
execute(imageUrl: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Symbols dialog.
*/
declare class OpenInsertSymbolDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenInsertSymbolDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a character into the document.
*/
declare class InsertSymbolCommand {
/**
* Executes the InsertSymbolCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param symbol A string value specifying symbols to insert.
* @param fontName A string value specifying the font of symbols to insert.
*/
execute(symbol: string, fontName: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a paragraph break at the current position in the document.
*/
declare class InsertParagraphCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertParagraphCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert text at the current position in the document.
*/
declare class InsertTextCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTextCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param text A string value specifying a text to insert.
* @param subDocumentId An integer value specifying the sub-document.
*/
execute(text: string, interval?: Interval | number, subDocumentId?: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete the text in a selected range.
*/
declare class DeleteCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to remove the previous word.
*/
declare class RemovePrevWordCommand extends CommandWithSimpleStateBase {
/**
* Executes the RemovePrevWordCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to remove the next word.
*/
declare class RemoveNextWordCommand extends CommandWithSimpleStateBase {
/**
* Executes the RemoveNextWordCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to move the cursor backwards and erase the character in that space.
*/
declare class BackspaceCommand extends CommandWithSimpleStateBase {
/**
* Executes the BackspaceCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to scale pictures in a selected range.
*/
declare class ChangePictureScaleCommand extends CommandBase {
/**
* Executes the ChangePictureScaleCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param scale The picture scale.
* @param x The picture scale object or the x-scale factor as a percent.
* @param y The y-scale factor as a percent.
*/
execute(x: number | Scale, y?: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to move the selected range to a specific position in the document.
*/
declare class MoveContentCommand extends CommandWithSimpleStateBase {
/**
* Executes the MoveContentCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param position An integer value specifying position to insert selected text.
*/
execute(position: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to copy the selected text and place it to the specified position.
*/
declare class CopyContentCommand extends CommandWithSimpleStateBase {
/**
* Executes the CopyContentCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param position An integer value specifying a position of the inserted text.
*/
execute(position: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a tab character at the current position in the document.
*/
declare class InsertTabCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTabCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to add a non-breaking space in place of a selected range.
*/
declare class InsertNonBreakingSpaceCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertNonBreakingSpaceCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Defines the scaling settings.
*/
declare class Scale {
/**
* Specifies the image's x-scale factor as a percent.
*/
x: number;
/**
* Specifies the image's y-scale factor as a percent.
*/
y: number;
}
/**
* A command to change page margin settings.
*/
declare class ChangePageMarginsCommand extends CommandBase {
/**
* Executes the ChangePageMarginsCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param left The margin settings object or the left margin in twips.
* @param top The top margin in twips.
* @param right The right margin in twips.
* @param bottom The bottom margin in twips.
*/
execute(left?: number | Margins, top?: number, right?: number, bottom?: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to invoke the Margins tab of the Page Setup dialog.
*/
declare class OpenPageMarginsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenPageMarginsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the page orientation.
*/
declare class ChangePageOrientationCommand extends CommandBase {
/**
* Executes the ChangePageOrientationCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param orientation The page orientation.
*/
execute(orientation: Orientation): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to invoke the Paper tab of the Page Setup dialog.
*/
declare class OpenPagePaperSizeDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenPagePaperSizeDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to set the page size.
*/
declare class SetPageSizeDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the SetPageSizeDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the page size.
*/
declare class ChangePageSizeCommand extends CommandBase {
/**
* Executes the ChangePageSizeCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param size The page size.
* @param width The page size object or the page width.
* @param height The page height.
*/
execute(width: number | Size, height?: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the number of section columns having the same width.
*/
declare class ChangeSectionEqualColumnCountCommand extends CommandBase {
/**
* Executes the ChangeSectionEqualColumnCountCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param columnCount An interger number specifying the number of section columns having the same width.
*/
execute(columnCount: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to invoke the Columns dialog.
*/
declare class OpenSectionColumnsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenSectionColumnsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the settings of individual section columns.
*/
declare class ChangeSectionColumnsCommand {
/**
* Executes the ChangeSectionColumnsCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param columns An array of SectionColumn objects.
*/
execute(columns: SectionColumn[]): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the background color of the page.
*/
declare class ChangePageColorCommand extends CommandBase {
/**
* Executes the ChangePageColorCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @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;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to activate the page header and begin editing.
*/
declare class InsertHeaderCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertHeaderCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to activate the page footer and begin editing.
*/
declare class InsertFooterCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertFooterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to link a header/footer to the previous section, so it has the same content.
*/
declare class LinkHeaderFooterToPreviousCommand extends CommandWithSimpleStateBase {
/**
* Executes the LinkHeaderFooterToPreviousCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the page footer from the page header in the header/footer editing mode.
*/
declare class GoToFooterCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToFooterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the page header from the page footer in the header/footer editing mode.
*/
declare class GoToHeaderCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToHeaderCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the next page header or footer in the header/footer editing mode.
*/
declare class GoToNextHeaderFooterCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToNextHeaderFooterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to navigate to the previous page header or footer in the header/footer editing mode.
*/
declare class GoToPreviousHeaderFooterCommand extends CommandWithSimpleStateBase {
/**
* Executes the GoToPreviousHeaderFooterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* 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.
*/
declare class SetDifferentFirstPageHeaderFooterCommand extends CommandWithBooleanStateBase {
/**
* Executes the SetDifferentFirstPageHeaderFooterCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param differentFirstPage true to apply a different text for the first page's header and footer, false to remove the difference.
*/
execute(differentFirstPage?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* 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.
*/
declare class SetDifferentOddAndEvenPagesHeaderFooterCommand extends CommandWithBooleanStateBase {
/**
* Executes the SetDifferentOddAndEvenPagesHeaderFooterCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param differentOddAndEvenPages true to apply a different text for the header and footer of the odd and even pages , false to remove the difference.
*/
execute(differentOddAndEvenPages?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to finish header/footer editing.
*/
declare class CloseHeaderFooterCommand extends CommandWithSimpleStateBase {
/**
* Executes the CloseHeaderFooterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Defines a section column in the document.
*/
declare class SectionColumn {
/**
* Specifies the width of the section column.
*/
width: number;
/**
* Specifies the space between adjacent section columns.
*/
spacing: number;
}
/**
* Defines the size settings.
*/
declare class Size {
/**
* Gets or sets the width value in twips.
*/
width: number;
/**
* Gets or sets the height value in twips.
*/
height: number;
}
/**
* Defines the margin settings.
*/
declare class Margins {
/**
* Gets or sets the left margin.
*/
left: number;
/**
* Gets or sets the top margin.
*/
top: number;
/**
* Gets or sets the right margin.
*/
right: number;
/**
* Gets or sets the bottom margin.
*/
bottom: number;
}
/**
* Lists values specifying the page orientation.
*/
declare enum Orientation {
/**
* Worksheet page orientation is landscape.
*/
Landscape = 0,
/**
* Worksheet page orientation is portrait.
*/
Portrait = 1
}
/**
* A command to add an RTF formatted content in the selected position.
*/
declare class InsertRtfCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertRtfCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param rtfText A string representing the RTF formatted content to insert.
* @param position A value specifying the position to insert in the specified sub-document.
* @param subDocumentId A value identifying the target sub-document.
* @param callback A callback function that passes the inserted content's Interval object and the bool parameter that displays whether the RTF formatted string is valid.
*/
execute(rtfText: string, position: number, subDocumentId?: number, callback?: (interval: Interval, isRtfValid: boolean) => void): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to receive a document's content in RTF format.
*/
declare class GetRtfCommand extends CommandWithSimpleStateBase {
/**
* Executes the GetRtfCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param interval An object specifying the required interval in the specified sub-document.
* @param callback A function that passes the RTF formatted string as a parameter.
* @param subDocumentId A value identifying the target sub-document.
*/
execute(interval: Interval, callback: (rtf: string) => void, subDocumentId?: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to assign a shortcut to the specified client command.
*/
declare class AssignShortcutCommand extends CommandWithSimpleStateBase {
/**
* Executes the AssignShortcutCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param keyCode A specifically generated code that uniquely identifies the combination of keys specified for a shortcut. This code is specified using the ASPxClientUtils.GetShortcutCode method.
* @param callback A callback function to execute when a shortcut is activated.
*/
execute(keyCode: number, callback: () => void): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Spelling dialog window.
*/
declare class OpenSpellingDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenSpellingDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Insert Table dialog.
*/
declare class OpenInsertTableDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenInsertTableDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Insert Table dialog.
*/
declare class InsertTableCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param columnCount An integer value specifying a number of columns in a generated table.
* @param rowCount An integer value specifying a number of rows in a generated table.
*/
execute(columnCount: number, rowCount: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Table Properties dialog.
*/
declare class OpenTableFormattingDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenTableFormattingDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the selected table's formatting.
*/
declare class ChangeTableFormattingCommand {
/**
* Executes the ChangeTableFormattingCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A TableFormattingSettings object containing the settings to format a table.
*/
execute(settings: TableFormattingSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the selected table's preferred row height.
*/
declare class ChangeTableRowPreferredHeightCommand extends CommandBase {
/**
* Executes the ChangeTableRowPreferredHeightCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param preferredHeight A TableHeightUnit object specifying preferred height of the selected table rows.
*/
execute(preferredHeight: TableHeightUnit): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the preferred cell width of the selected table rows.
*/
declare class ChangeTableCellPreferredWidthCommand extends CommandBase {
/**
* Executes the ChangeTableCellPreferredWidthCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param preferredWidth A TableWidthUnit object specifying preferred width of the selected table rows.
*/
execute(preferredWidth: TableWidthUnit): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the selected table's preferred column width.
*/
declare class ChangeTableColumnPreferredWidthCommand extends CommandBase {
/**
* Executes the ChangeTableColumnPreferredWidthCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param preferredWidth A TableWidthUnit object specifying preferred width of the selected table columns.
*/
execute(preferredWidth: TableWidthUnit): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the cell formatting of the selected table elements.
*/
declare class ChangeTableCellFormattingCommand {
/**
* Executes the ChangeTableCellFormattingCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A TableFormattingSettings object specifying cell formatting of the selected table elements.
*/
execute(settings: TableCellFormattingSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to insert a table column to the left of the current position in the table.
*/
declare class InsertTableColumnToTheLeftCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableColumnToTheLeftCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a table column to the right of the current position in the table.
*/
declare class InsertTableColumnToTheRightCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableColumnToTheRightCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a row in a table below the selected row.
*/
declare class InsertTableRowBelowCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableRowBelowCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert a row in a table above the selected row.
*/
declare class InsertTableRowAboveCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableRowAboveCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete the selected table rows.
*/
declare class DeleteTableRowsCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteTableRowsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete the selected table columns.
*/
declare class DeleteTableColumnsCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteTableColumnsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert table cells with a horizontal shift into the selected table.
*/
declare class InsertTableCellWithShiftToTheLeftCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableCellWithShiftToTheLeftCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete the selected table cells with a horizontal shift.
*/
declare class DeleteTableCellsWithShiftHorizontallyCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteTableCellsWithShiftHorizontallyCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete the selected table cells with a vertical shift.
*/
declare class DeleteTableCellsWithShiftVerticallyCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteTableCellsWithShiftVerticallyCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to delete the selected table.
*/
declare class DeleteTableCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteTableCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Insert Cells dialog.
*/
declare class InsertTableCellsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableCellsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Delete Cells dialog.
*/
declare class DeleteTableCellsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the DeleteTableCellsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to merge the selected table cells.
*/
declare class MergeTableCellsCommand extends CommandWithSimpleStateBase {
/**
* Executes the MergeTableCellsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Split Cells dialog.
*/
declare class SplitTableCellsDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the SplitTableCellsDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to split the selected table cells based on the specified options.
*/
declare class SplitTableCellsCommand {
/**
* Executes the SplitTableCellsCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param rowCount An integer value specifying a number of rows in the split table cells.
* @param columnCount An integer value specifying a number of columns in the split table cells.
* @param mergeBeforeSplit true to merge the selected cells before the splitting; otherwise, false.
*/
execute(rowCount: number, columnCount: number, mergeBeforeSplit: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to insert table cells with a vertical shift into the selected table.
*/
declare class InsertTableCellsWithShiftToTheVerticallyCommand extends CommandWithSimpleStateBase {
/**
* Executes the InsertTableCellsWithShiftToTheVerticallyCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to invoke the Borders and Shading table dialog.
*/
declare class OpenTableBordersAndShadingDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenTableBordersAndShadingDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change borders and shading of the selected table elements.
*/
declare class ChangeTableBordersAndShadingCommand {
/**
* Executes the ChangeTableBordersAndShadingCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A TableBorderSettings object with settings specifying table borders.
* @param applyToWholeTable true to apply the border settings to the whole table, false to apply the border settings to the selected cells.
*/
execute(settings: TableBordersSettings, applyToWholeTable: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply top-left alignment for the selected table cells.
*/
declare class ToggleTableCellAlignTopLeftCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignTopLeftCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply top-center alignment for the selected table cells.
*/
declare class ToggleTableCellAlignTopCenterCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignTopCenterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply top-right alignment for the selected table cells.
*/
declare class ToggleTableCellAlignTopRightCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignTopRightCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply middle-left alignment for the selected table cells.
*/
declare class ToggleTableCellAlignMiddleLeftCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignMiddleLeftCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply middle-center alignment for the selected table cells.
*/
declare class ToggleTableCellAlignMiddleCenterCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignMiddleCenterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply middle-right alignment for the selected table cells.
*/
declare class ToggleTableCellAlignMiddleRightCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignMiddleRightCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply bottom-left alignment for the selected table cells.
*/
declare class ToggleTableCellAlignBottomLeftCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignBottomLeftCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply bottom-center alignment for the selected table cells.
*/
declare class ToggleTableCellAlignBottomCenterCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignBottomCenterCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to apply bottom-right alignment for the selected table cells.
*/
declare class ToggleTableCellAlignBottomRightCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAlignBottomRightCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the selected table's style.
*/
declare class ChangeTableStyleCommand extends CommandBase {
/**
* Executes the ChangeTableStyleCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param style A TableStyle object specifying the style applying to the table.
*/
execute(style: string | TableStyle): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle top borders for selected cells on/off.
*/
declare class ToggleTableCellTopBorderCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellTopBorderCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle right borders for selected cells on/off.
*/
declare class ToggleTableCellRightBorderCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellRightBorderCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle bottom borders for selected cells on/off.
*/
declare class ToggleTableCellBottomBorderCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellBottomBorderCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle left borders for selected cells on/off.
*/
declare class ToggleTableCellLeftBorderCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellLeftBorderCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to remove the borders of the selected table cells.
*/
declare class RemoveTableCellBordersCommand extends CommandWithSimpleStateBase {
/**
* Executes the RemoveTableCellBordersCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to toggle all borders for selected cells on/off.
*/
declare class ToggleTableCellAllBordersCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellAllBordersCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle inner borders for selected cells on/off.
*/
declare class ToggleTableCellInsideBordersCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellInsideBordersCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle inner horizontal borders for selected cells on/off.
*/
declare class ToggleTableCellInsideHorizontalBordersCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellInsideHorizontalBordersCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle inner vertical borders for selected cells on/off.
*/
declare class ToggleTableCellInsideVerticalBordersCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellInsideVerticalBordersCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle outer borders for selected cells on/off.
*/
declare class ToggleTableCellOutsideBordersCommand extends CommandWithBooleanStateBase {
/**
* Executes the ToggleTableCellOutsideBordersCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the selected table's style options.
*/
declare class ChangeTableLookCommand extends CommandBase {
/**
* Executes the ChangeTableLookCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A TableLookSettings object containing the settings that modify the table appearance.
*/
execute(settings: TableLookSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the repository item's table border style.
*/
declare class ChangeTableBorderRepositoryItemCommand extends CommandBase {
/**
* Executes the ChangeTableBorderRepositoryItemCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A TableBorderSettings object specifying the repository item's table border style.
*/
execute(settings: TableBorderSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change cell shading in the selected table elements.
*/
declare class ChangeTableCellShadingCommand extends CommandBase {
/**
* Executes the ChangeTableCellShadingCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param color A string specifying the color of the selected cells' shading. May be specified as a color name or a hex color value.
*/
execute(color: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle the display of grid lines for a table with no borders applied - on/off.
*/
declare class ShowTableGridLinesCommand extends CommandWithBooleanStateBase {
/**
* Executes the ShowTableGridLinesCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param showTableGridLines true to display table grid lines, false to hide table grid lines.
*/
execute(showTableGridLines?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to fit the specified table to its contents.
*/
declare class ToggleTableAutoFitContentsCommand extends CommandWithSimpleStateBase {
/**
* Executes the ToggleTableAutoFitContentsCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to fit the specified table to a document's window.
*/
declare class ToggleTableAutoFitWindowCommand extends CommandWithSimpleStateBase {
/**
* Executes the ToggleTableAutoFitWindowCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to disable automatic adjusting of the selected table.
*/
declare class ToggleTableFixedColumnWidthCommand extends CommandWithSimpleStateBase {
/**
* Executes the ToggleTableFixedColumnWidthCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Contains the table style settings that modify the table appearance.
*/
declare class TableLookSettings {
/**
* Specifies whether special formatting is applied to the first row of the table.
*/
applyFirstRow: boolean;
/**
* Specifies whether special formatting is applied to the last row of the table.
*/
applyLastRow: boolean;
/**
* Specifies whether special formatting is applied to the first column of the table.
*/
applyFirstColumn: boolean;
/**
* Specifies whether special formatting is applied to the last column of the table.
*/
applyLastColumn: boolean;
/**
* Specifies whether row banding formatting is not applied to the table.
*/
doNotApplyRowBanding: boolean;
/**
* Specifies whether column banding formatting is not applied to the table.
*/
doNotApplyColumnBanding: boolean;
}
/**
* Contains settings to define table borders.
*/
declare class TableBordersSettings {
/**
* Gets or sets the top border's settings.
*/
top: TableBorderSettings;
/**
* Gets or sets the right border's settings.
*/
right: TableBorderSettings;
/**
* Gets or sets the bottom border's settings.
*/
bottom: TableBorderSettings;
/**
* Gets or sets the left border's settings.
*/
left: TableBorderSettings;
/**
* Gets or sets the inside horizontal border's settings.
*/
insideHorizontal: TableBorderSettings;
/**
* Gets or sets the inside vertical border's settings.
*/
insideVertical: TableBorderSettings;
/**
* Gets or sets the background color of table borders.
*/
backgroundColor: string;
}
/**
* Contains settings to define a table border.
*/
declare class TableBorderSettings {
/**
* Gets or sets the border color.
*/
color: string;
/**
* Gets or sets the border line width in twips.
*/
width: number;
/**
* Gets or sets the border line style.
*/
style: BorderLineStyle;
}
/**
* Lists values to specify the line styles for table cell borders.
*/
declare enum BorderLineStyle {
/**
* No border.
*/
Nil = -1,
/**
* No border.
*/
None = 0,
/**
* A single solid line.
*/
Single = 1,
/**
* Single line.
*/
Thick = 2,
/**
* Double solid lines.
*/
Double = 3,
/**
* Dots.
*/
Dotted = 4,
/**
* Dashes.
*/
Dashed = 5,
/**
* A dash followed by a dot.
*/
DotDash = 6,
/**
* A dash followed by two dots.
*/
DotDotDash = 7,
/**
* Triple line.
*/
Triple = 8,
/**
* An internal single thin solid line surrounded by a single thick solid line with a small gap between them.
*/
ThinThickSmallGap = 9,
/**
* An internal single thick solid line surrounded by a single thin solid line with a small gap between them.
*/
ThickThinSmallGap = 10,
/**
* An internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a small gap between all lines.
*/
ThinThickThinSmallGap = 11,
/**
* An internal single thin solid line surrounded by a single thick solid line with a medium gap between them.
*/
ThinThickMediumGap = 12,
/**
* An internal single thick solid line surrounded by a single thin solid line with a medium gap between them.
*/
ThickThinMediumGap = 13,
/**
* An internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a medium gap between all lines.
*/
ThinThickThinMediumGap = 14,
/**
* An internal single thin solid line surrounded by a single thick solid line with a large gap between them.
*/
ThinThickLargeGap = 15,
/**
* An internal single thick solid line surrounded by a single thin solid line with a large gap between them.
*/
ThickThinLargeGap = 16,
/**
* An internal single thin solid line surrounded by a single thick solid line surrounded by a single thin solid line with a large gap between all lines.
*/
ThinThickThinLargeGap = 17,
/**
* Wavy line.
*/
Wave = 18,
/**
* Double wavy solid lines.
*/
DoubleWave = 19,
/**
* A dash followed by a small gap.
*/
DashSmallGap = 20,
/**
* A series of alternating thin and thick strokes, resembling a barber pole.
*/
DashDotStroked = 21,
/**
* A line border consisting of three staged gradient lines around the cell, getting darker towards the cell.
*/
ThreeDEmboss = 22,
/**
* A line border consisting of three staged gradient lines around the cell, getting darker away from the cell.
*/
ThreeDEngrave = 23,
/**
* The border appears to be outset.
*/
Outset = 24,
/**
* The border appears to be inset.
*/
Inset = 25,
/**
* Apples Art Border
*/
Apples = 26,
/**
* Arched Scallops Art Border.
*/
ArchedScallops = 27,
/**
* Baby Pacifier Art Border.
*/
BabyPacifier = 28,
/**
* Baby Rattle Art Border.
*/
BabyRattle = 29,
/**
* Three Color Balloons Art Border.
*/
Balloons3Colors = 30,
/**
* Hot Air Balloons Art Border.
*/
BalloonsHotAir = 31,
/**
* Black Dash Art Border.
*/
BasicBlackDashes = 32,
/**
* Black Dot Art Border.
*/
BasicBlackDots = 33,
/**
* Black Square Art Border.
*/
BasicBlackSquares = 34,
/**
* Thin Line Art Border.
*/
BasicThinLines = 35,
/**
* White Dash Art Border.
*/
BasicWhiteDashes = 36,
/**
* White Dot Art Border.
*/
BasicWhiteDots = 37,
/**
* White Square Art Border.
*/
BasicWhiteSquares = 38,
/**
* Wide Inline Art Border.
*/
BasicWideInline = 39,
/**
* Wide Midline Art Border.
*/
BasicWideMidline = 40,
/**
* Wide Outline Art Border.
*/
BasicWideOutline = 41,
/**
* Bats Art Border.
*/
Bats = 42,
/**
* Birds Art Border.
*/
Birds = 43,
/**
* Birds Flying Art Border.
*/
BirdsFlight = 44,
/**
* Cabin Art Border.
*/
Cabins = 45,
/**
* Cake Art Border.
*/
CakeSlice = 46,
/**
* Candy Corn Art Border.
*/
CandyCorn = 47,
/**
* Knot Work Art Border.
*/
CelticKnotwork = 48,
/**
* Certificate Banner Art Border.
*/
CertificateBanner = 49,
/**
* Chain Link Art Border.
*/
ChainLink = 50,
/**
* Champagne Bottle Art Border.
*/
ChampagneBottle = 51,
/**
* Black and White Bar Art Border.
*/
CheckedBarBlack = 52,
/**
* Color Checked Bar Art Border.
*/
CheckedBarColor = 53,
/**
* Checkerboard Art Border.
*/
Checkered = 54,
/**
* Christmas Tree Art Border.
*/
ChristmasTree = 55,
/**
* Circles And Lines Art Border.
*/
CirclesLines = 56,
/**
* Circles and Rectangles Art Border.
*/
CirclesRectangles = 57,
/**
* Wave Art Border.
*/
ClassicalWave = 58,
/**
* Clocks Art Border.
*/
Clocks = 59,
/**
* Compass Art Border.
*/
Compass = 60,
/**
* Confetti Art Border.
*/
Confetti = 61,
/**
* Confetti Art Border.
*/
ConfettiGrays = 62,
/**
* Confetti Art Border.
*/
ConfettiOutline = 63,
/**
* Confetti Streamers Art Border.
*/
ConfettiStreamers = 64,
/**
* Confetti Art Border.
*/
ConfettiWhite = 65,
/**
* Corner Triangle Art Border.
*/
CornerTriangles = 66,
/**
* Dashed Line Art Border.
*/
CouponCutoutDashes = 67,
/**
* Dotted Line Art Border.
*/
CouponCutoutDots = 68,
/**
* Maze Art Border.
*/
CrazyMaze = 69,
/**
* Butterfly Art Border.
*/
CreaturesButterfly = 70,
/**
* Fish Art Border.
*/
CreaturesFish = 71,
/**
* Insects Art Border.
*/
CreaturesInsects = 72,
/**
* Ladybug Art Border.
*/
CreaturesLadyBug = 73,
/**
* Cross-stitch Art Border.
*/
CrossStitch = 74,
/**
* Cupid Art Border.
*/
Cup = 75,
/**
* Archway Art Border.
*/
DecoArch = 76,
/**
* Color Archway Art Border.
*/
DecoArchColor = 77,
/**
* Blocks Art Border.
*/
DecoBlocks = 78,
/**
* Gray Diamond Art Border.
*/
DiamondsGray = 79,
/**
* Double D Art Border.
*/
DoubleD = 80,
/**
* Diamond Art Border.
*/
DoubleDiamonds = 81,
/**
* Earth Art Border.
*/
Earth1 = 82,
/**
* Earth Art Border.
*/
Earth2 = 83,
/**
* Shadowed Square Art Border.
*/
EclipsingSquares1 = 84,
/**
* Shadowed Square Art Border.
*/
EclipsingSquares2 = 85,
/**
* Painted Egg Art Border.
*/
EggsBlack = 86,
/**
* Fans Art Border.
*/
Fans = 87,
/**
* Film Reel Art Border.
*/
Film = 88,
/**
* Firecracker Art Border.
*/
Firecrackers = 89,
/**
* Flowers Art Border.
*/
FlowersBlockPrint = 90,
/**
* Daisy Art Border.
*/
FlowersDaisies = 91,
/**
* Flowers Art Border.
*/
FlowersModern1 = 92,
/**
* Flowers Art Border.
*/
FlowersModern2 = 93,
/**
* Pansy Art Border.
*/
FlowersPansy = 94,
/**
* Red Rose Art Border.
*/
FlowersRedRose = 95,
/**
* Roses Art Border.
*/
FlowersRoses = 96,
/**
* Flowers in a Teacup Art Border.
*/
FlowersTeacup = 97,
/**
* Small Flower Art Border.
*/
FlowersTiny = 98,
/**
* Gems Art Border.
*/
Gems = 99,
/**
* Gingerbread Man Art Border.
*/
GingerbreadMan = 100,
/**
* Triangle Gradient Art Border.
*/
Gradient = 101,
/**
* Handmade Art Border.
*/
Handmade1 = 102,
/**
* Handmade Art Border.
*/
Handmade2 = 103,
/**
* Heart-Shaped Balloon Art Border.
*/
HeartBalloon = 104,
/**
* Gray Heart Art Border.
*/
HeartGray = 105,
/**
* Hearts Art Border.
*/
Hearts = 106,
/**
* Pattern Art Border.
*/
HeebieJeebies = 107,
/**
* Holly Art Border.
*/
Holly = 108,
/**
* House Art Border.
*/
HouseFunky = 109,
/**
* Circular Art Border.
*/
Hypnotic = 110,
/**
* Ice Cream Cone Art Border.
*/
IceCreamCones = 111,
/**
* Light Bulb Art Border.
*/
LightBulb = 112,
/**
* Lightning Art Border.
*/
Lightning1 = 113,
/**
* Lightning Art Border.
*/
Lightning2 = 114,
/**
* Maple Leaf Art Border.
*/
MapleLeaf = 115,
/**
* Muffin Art Border.
*/
MapleMuffins = 116,
/**
* Map Pins Art Border.
*/
MapPins = 117,
/**
* Marquee Art Border.
*/
Marquee = 118,
/**
* Marquee Art Border.
*/
MarqueeToothed = 119,
/**
* Moon Art Border.
*/
Moons = 120,
/**
* Mosaic Art Border.
*/
Mosaic = 121,
/**
* Musical Note Art Border.
*/
MusicNotes = 122,
/**
* Patterned Art Border.
*/
Northwest = 123,
/**
* Oval Art Border.
*/
Ovals = 124,
/**
* Package Art Border.
*/
Packages = 125,
/**
* Black Palm Tree Art Border.
*/
PalmsBlack = 126,
/**
* Color Palm Tree Art Border.
*/
PalmsColor = 127,
/**
* Paper Clip Art Border.
*/
PaperClips = 128,
/**
* Papyrus Art Border.
*/
Papyrus = 129,
/**
* Party Favor Art Border.
*/
PartyFavor = 130,
/**
* Party Glass Art Border.
*/
PartyGlass = 131,
/**
* Pencils Art Border.
*/
Pencils = 132,
/**
* Character Art Border.
*/
People = 133,
/**
* Character With Hat Art Border.
*/
PeopleHats = 134,
/**
* Waving Character Border.
*/
PeopleWaving = 135,
/**
* Poinsettia Art Border.
*/
Poinsettias = 136,
/**
* Postage Stamp Art Border.
*/
PostageStamp = 137,
/**
* Pumpkin Art Border.
*/
Pumpkin1 = 138,
/**
* Push Pin Art Border.
*/
PushPinNote1 = 139,
/**
* Push Pin Art Border.
*/
PushPinNote2 = 140,
/**
* Pyramid Art Border.
*/
Pyramids = 141,
/**
* Pyramid Art Border.
*/
PyramidsAbove = 142,
/**
* Quadrants Art Border.
*/
Quadrants = 143,
/**
* Rings Art Border.
*/
Rings = 144,
/**
* Safari Art Border.
*/
Safari = 145,
/**
* Saw tooth Art Border.
*/
Sawtooth = 146,
/**
* Gray Saw tooth Art Border.
*/
SawtoothGray = 147,
/**
* Scared Cat Art Border.
*/
ScaredCat = 148,
/**
* Umbrella Art Border.
*/
Seattle = 149,
/**
* Shadowed Squares Art Border.
*/
ShadowedSquares = 150,
/**
* Shark Tooth Art Border.
*/
SharksTeeth = 151,
/**
* Bird Tracks Art Border.
*/
ShorebirdTracks = 152,
/**
* Rocket Art Border.
*/
Skyrocket = 153,
/**
* Snowflake Art Border.
*/
SnowflakeFancy = 154,
/**
* Snowflake Art Border.
*/
Snowflakes = 155,
/**
* Sombrero Art Border.
*/
Sombrero = 156,
/**
* Southwest-themed Art Border.
*/
Southwest = 157,
/**
* Stars Art Border.
*/
Stars = 158,
/**
* 3-D Stars Art Border.
*/
Stars3d = 159,
/**
* Stars Art Border.
*/
StarsBlack = 160,
/**
* Stars With Shadows Art Border.
*/
StarsShadowed = 161,
/**
* Stars On Top Art Border.
*/
StarsTop = 162,
/**
* Sun Art Border.
*/
Sun = 163,
/**
* Whirligig Art Border.
*/
Swirligig = 164,
/**
* Torn Paper Art Border.
*/
TornPaper = 165,
/**
* Black Torn Paper Art Border.
*/
TornPaperBlack = 166,
/**
* Tree Art Border.
*/
Trees = 167,
/**
* Triangle Art Border.
*/
TriangleParty = 168,
/**
* Triangles Art Border.
*/
Triangles = 169,
/**
* Tribal Art Border One.
*/
Tribal1 = 170,
/**
* Tribal Art Border Two.
*/
Tribal2 = 171,
/**
* Tribal Art Border Three.
*/
Tribal3 = 172,
/**
* Tribal Art Border Four.
*/
Tribal4 = 173,
/**
* Tribal Art Border Five.
*/
Tribal5 = 174,
/**
* Tribal Art Border Six.
*/
Tribal6 = 175,
/**
* Twisted Lines Art Border.
*/
TwistedLines1 = 176,
/**
* Twisted Lines Art Border.
*/
TwistedLines2 = 177,
/**
* Vine Art Border.
*/
Vine = 178,
/**
* Wavy Line Art Border.
*/
Waveline = 179,
/**
* Weaving Angles Art Border.
*/
WeavingAngles = 180,
/**
* Weaving Braid Art Border.
*/
WeavingBraid = 181,
/**
* Weaving Ribbon Art Border.
*/
WeavingRibbon = 182,
/**
* Weaving Strips Art Border.
*/
WeavingStrips = 183,
/**
* White Flowers Art Border.
*/
WhiteFlowers = 184,
/**
* Woodwork Art Border.
*/
Woodwork = 185,
/**
* Crisscross Art Border.
*/
XIllusions = 186,
/**
* Triangle Art Border.
*/
ZanyTriangles = 187,
/**
* Zigzag Art Border.
*/
ZigZag = 188,
/**
* Zigzag stitch.
*/
ZigZagStitch = 189
}
/**
* Contains the settings to define the table cell formatting.
*/
declare class TableCellFormattingSettings {
/**
* Gets or sets a table cell's preferred width.
*/
preferredWidth: TableWidthUnit;
/**
* Gets or sets the vertical alignment of a table cell's content.
*/
verticalAlignment: TableCellVerticalAlignment;
/**
* Sspecifies whether text is wrapped in a table cell.
*/
noWrap: boolean;
/**
* Gets or sets a table cell's left margin in twips.
*/
marginLeft: number;
/**
* Gets or sets a table cell's right margin in twips.
*/
marginRight: number;
/**
* Gets or sets a table cell's top margin in twips.
*/
marginTop: number;
/**
* Gets or sets a table cell's bottom margin in twips.
*/
marginBottom: number;
/**
* Specifies whether a table cell's margins are inherited from the table level settings.
*/
marginsSameAsTable: boolean;
}
/**
* Lists possible vertical alignments for cell content.
*/
declare enum TableCellVerticalAlignment {
/**
* The cell content is vertically aligned at the top.
*/
Top = 0,
/**
* The cell content is vertically justified.
*/
Both = 1,
/**
* The cell content is centered vertically.
*/
Center = 2,
/**
* The cell content is vertically aligned at the bottom.
*/
Bottom = 3
}
/**
* Contains the settings to format a table.
*/
declare class TableFormattingSettings {
/**
* Gets or sets the preferred width of cells in the table.
*/
preferredWidth: TableWidthUnit;
/**
* Gets or sets the alignment of table rows.
*/
alignment: TableRowAlignment;
/**
* Gets or sets the table's left indent in twips.
*/
indent: number;
/**
* Gets or sets the spacing between table cells in twips.
*/
spacingBetweenCells: number;
/**
* Gets or sets a value specifying whether spacing is allowed between table cells.
*/
allowSpacingBetweenCells: boolean;
/**
* Gets or sets a value that specifying whether to allow automatic resizing of table cells to fit their contents.
*/
resizeToFitContent: boolean;
/**
* Gets or sets the default left margin for cells in the table in twips.
*/
defaultCellMarginLeft: number;
/**
* Gets or sets the default right margin for cells in the table in twips.
*/
defaultCellMarginRight: number;
/**
* Gets or sets the default top margin for cells in the table in twips.
*/
defaultCellMarginTop: number;
/**
* Gets or sets the default bottom margin for cells in the table in twips.
*/
defaultCellMarginBottom: number;
}
/**
* Contains settings defining the table width's measurement units and value.
*/
declare class TableWidthUnit {
/**
* Gets or sets the table width value in twips.
*/
value: number;
/**
* Gets or sets the unit type for the table width.
*/
type: TableWidthUnitType;
}
/**
* Contains settings defining the table height's measurement units and value.
*/
declare class TableHeightUnit {
/**
* Gets or sets the table height value in twips.
*/
value: number;
/**
* Gets or sets the unit type for the table height.
*/
type: TableHeightUnitType;
}
/**
* Lists values that specify unit types for the table height.
*/
declare enum TableHeightUnitType {
/**
* The minimum height will be the specified height. The height can be increased, if needed, to accommodate the content.
*/
Minimum = 0,
/**
* The height increases automatically to accommodate the content.
*/
Auto = 1,
/**
* The exact height as specified. If the text cannot fit the height, it will appear truncated.
*/
Exact = 2
}
/**
* Lists alignments allowed for the table row.
*/
declare enum TableRowAlignment {
/**
* Justified.
*/
Both = 0,
/**
* Align center.
*/
Center = 1,
/**
* Distribute all characters equally.
*/
Distribute = 2,
/**
* Align left.
*/
Left = 3,
/**
* Align to the list tab.
*/
NumTab = 4,
/**
* Align right.
*/
Right = 5
}
/**
* Lists values that specify unit types for the table width.
*/
declare enum TableWidthUnitType {
/**
* Not set.
*/
Nil = 0,
/**
* Automatically determined width.
*/
Auto = 1,
/**
* Width in fiftieths of a percent.
*/
FiftiethsOfPercent = 2,
/**
* Width in units of measurements that are currently in effect for the document.
*/
ModelUnits = 3
}
/**
* A command to change the font name of characters in a selected range.
*/
declare class ChangeFontNameCommand extends CommandBase {
/**
* Executes the ChangeFontNameCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontName A string specifying the font name.
*/
execute(fontName: string): boolean;
/**
* Lists names of fonts available in the control.
*/
readonly fontNames: string[];
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the font size of characters in a selected range.
*/
declare class ChangeFontSizeCommand extends CommandBase {
/**
* Executes the ChangeFontSizeCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontSize An integer number specifying the font size in points.
*/
execute(fontSize: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to increase the font size of characters in a selected range to the closest larger predefined value.
*/
declare class IncreaseFontSizeCommand extends CommandWithSimpleStateBase {
/**
* Executes the IncreaseFontSizeCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to decrease the font size of characters in a selected range to the closest smaller predefined value.
*/
declare class DecreaseFontSizeCommand extends CommandWithSimpleStateBase {
/**
* Executes the DecreaseFontSizeCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to convert the selected text to upper case.
*/
declare class MakeTextUpperCaseCommand extends CommandWithSimpleStateBase {
/**
* Executes the MakeTextUpperCaseCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to convert the selected text to lower case.
*/
declare class MakeTextLowerCaseCommand extends CommandWithSimpleStateBase {
/**
* Executes the MakeTextLowerCaseCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to capitalize each word in the selected sentence.
*/
declare class CapitalizeEachWordTextCaseCommand extends CommandWithSimpleStateBase {
/**
* Executes the CapitalizeEachWordTextCaseCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to toggle the case for each character - upper case becomes lower, lower case becomes upper.
*/
declare class ToggleTextCaseCommand extends CommandWithSimpleStateBase {
/**
* Executes the ToggleTextCaseCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the bold formatting of characters in a selected range.
*/
declare class ChangeFontBoldCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangeFontBoldCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontBold true to apply bold formatting to the text, false to remove bold formatting.
*/
execute(fontBold?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the italic formatting of characters in a selected range.
*/
declare class ChangeFontItalicCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangeFontItalicCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontItalic true to apply italic formatting to the text, false to remove italic formatting.
*/
execute(fontItalic?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the underline formatting of characters in a selected range.
*/
declare class ChangeFontUnderlineCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangeFontUnderlineCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontUnderline true to apply underline formatting to the text, false to remove underline formatting.
*/
execute(fontUnderline?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the strikeout formatting of characters in a selected range.
*/
declare class ChangeFontStrikeoutCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangeFontStrikeoutCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontStrikeout true to apply strikeout formatting to the text, false to remove strikeout formatting.
*/
execute(fontStrikeout?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the superscript formatting of characters in a selected range.
*/
declare class ChangeFontSuperscriptCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangeFontSuperscriptCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontSuperscript true to apply superscript formatting to the text, false to remove superscript formatting.
*/
execute(fontSuperscript?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the subscript formatting of characters in the selected range.
*/
declare class ChangeFontSubscriptCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangeFontSubscriptCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param fontSubscript true to apply subscript formatting to the text, false to remove subscript formatting.
*/
execute(fontSubscript?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the font color of characters in a selected range.
*/
declare class ChangeFontForeColorCommand extends CommandBase {
/**
* Executes the ChangeFontForeColorCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param color A string specifying the font color. May be specified as a color name or a hex color value.
*/
execute(color: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the background color of characters in a selected range.
*/
declare class ChangeFontBackColorCommand extends CommandBase {
/**
* Executes the ChangeFontBackColorCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param color A string specifying the background font color. May be specified as a color name or a hex color value.
*/
execute(color: string): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to reset the selected text's formatting to default.
*/
declare class ClearFormattingCommand extends CommandWithSimpleStateBase {
/**
* Executes the ClearFormattingCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the selected range's style.
*/
declare class ChangeStyleCommand extends CommandBase {
/**
* Executes the ChangeStyleCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param style An object that contains the style settings object, or the style name.
* @param isParagraphStyle true to apply style settings to a paragraph; otherwise, false.
*/
execute(style: string | StyleBase, isParagraphStyle?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to invoke the Font dialog allowing end-users to change the font, size and style of the selected text.
*/
declare class OpenFontFormattingDialogCommand extends CommandWithSimpleStateBase {
/**
* Executes the OpenFontFormattingDialogCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to convert the text of all selected sentences to sentence case.
*/
declare class MakeTextSentenceCaseCommand extends CommandWithSimpleStateBase {
/**
* Executes the MakeTextSentenceCaseCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to switch the text case at the current position in the document.
*/
declare class SwitchTextCaseCommand extends CommandWithSimpleStateBase {
/**
* Executes the SwitchTextCaseCommand command.
*/
execute(): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* A command to change the font formatting of characters in a selected range.
*/
declare class ChangeFontFormattingCommand extends CommandBase {
/**
* Executes the ChangeFontFormattingCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param settings A FontFormattingSettings object specifying font formatting settings.
*/
execute(settings: FontFormattingSettings): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* Contains settings to define the font formatting.
*/
declare class FontFormattingSettings {
/**
* Gets or sets the character(s) font name.
*/
fontName: string;
/**
* Gets or sets the character(s) font size (in points).
*/
size: number;
/**
* Gets or sets the foreground color of characters.
*/
foreColor: string;
/**
* Gets or sets the character background color.
*/
backColor: string;
/**
* Gets or sets the type of underline applied to the character(s).
*/
underline: boolean;
/**
* Gets or sets the color of the underline for the specified characters.
*/
underlineColor: string;
/**
* Gets or sets whether the character formatting is bold.
*/
bold: boolean;
/**
* Gets or sets a value indicating whether a character(s) is italicized.
*/
italic: boolean;
/**
* Gets or sets a value specifying whether the strikeout formatting is applied to a character(s).
*/
strikeout: boolean;
/**
* Gets or sets whether only word characters are underlined.
*/
underlineWordsOnly: boolean;
/**
* Gets or sets a value specifying character script formatting.
*/
script: CharacterFormattingScript;
/**
* Gets or sets a value indicating whether all characters are capital letters.
*/
allCaps: boolean;
/**
* Gets or sets a value indicating whether a character(s) is hidden.
*/
hidden: boolean;
}
/**
* Lists values specifying character script formatting.
*/
declare enum CharacterFormattingScript {
/**
* Specifies that the text is not formatted as subscript or as superscript.
*/
Normal = 0,
/**
* Formats text as subscript.
*/
Subscript = 1,
/**
* Formats text as superscript.
*/
Superscript = 2
}
/**
* A command to toggle the horizontal ruler's visibility.
*/
declare class ShowHorizontalRulerCommand extends CommandWithBooleanStateBase {
/**
* Executes the ShowHorizontalRulerCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param show true, to show the horizontal ruler; otherwise, false.
*/
execute(show?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to toggle the fullscreen mode.
*/
declare class SetFullscreenCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangePageMarginsCommand command. true if the command has been successfully executed; false if the command execution has failed.
* @param show true, to enable fullscreen mode; otherwise, false.
*/
execute(show?: boolean): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to change the Rich Edit's document view type.
*/
declare class ChangeViewTypeCommand extends CommandWithBooleanStateBase {
/**
* Executes the ChangeViewTypeCommand command with the specified parameter. A Boolean value identifying whether method execution was successful or failed.
* @param viewType A string value specifying the Rich Edit's document view type.
*/
execute(viewType: ViewType): boolean;
/**
* Gets information about the command's state.
*/
getState(): CommandState;
}
/**
* A command to force synchronizing the server document model with the client model and execute a callback function if it is necessary.
*/
declare class ForceSyncWithServerCommand extends CommandBase {
/**
* Executes the ForceSyncWithServerCommand command with the specified parameter. true if the command has been successfully executed; false if the command execution has failed.
* @param callback A callback function that is performed when the server model is updated.
*/
execute(callback: () => void): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Lists values specifying the Rich Edit's document view type.
*/
declare enum ViewType {
/**
* The simple view is enabled.
*/
Simple = 0,
/**
* The print layout is enabled.
*/
PrintLayout = 1
}
/**
* A command to insert content created on the server to the client model.
*/
declare class InsertContentFromServerCommand extends CommandBase {
/**
* Executes the InsertContentFromServerCommand command with the specified parameters. true if the command has been successfully executed; false if the command execution has failed.
* @param requestId An integer value identifying the request to the server.
* @param position An integer value specifying position where to insert content to the active sub-document.
* @param subDocumentId An integer value identifying the target sub-document.
*/
execute(requestId: string, position?: number, subDocumentId?: number): boolean;
/**
* Gets information about the command's state.
*/
getState(): SimpleCommandState;
}
/**
* Contains a set of the available client commands.
*/
declare class RichEditCommands {
/**
* Gets a command to prevent the control UI from being updated until the RichEditCommands.endUpdate method is called.
*/
beginUpdate(): void;
/**
* Re-enables render operations after a call to the RichEditCommands.beginUpdate method and forces immediate re-rendering.
*/
endUpdate(): void;
/**
* Gets a command to create a new empty document.
*/
readonly fileNew: FileNewCommand;
/**
* Gets a command to open a document stored in the specified file.
*/
readonly fileOpen: FileOpenCommand;
/**
* Gets a command to invoke the File Open dialog allowing one to select and load a document file into RichEdit.
*/
readonly fileOpenDialog: FileOpenDialogCommand;
/**
* Gets a command to save the document at its original location on the server.
*/
readonly fileSave: FileSaveCommand;
/**
* Gets a command to download the document specifying the file's extension.
*/
readonly fileDownload: FileDownloadCommand;
/**
* Gets a command to save a document in a file with the specified path.
*/
readonly fileSaveAs: FileSaveAsCommand;
/**
* 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.
*/
readonly fileSaveAsDialog: FileSaveAsDialogCommand;
/**
* Gets a command to invoke a browser-specific Print dialog allowing one to print the current document.
*/
readonly filePrint: FilePrintCommand;
/**
* Gets a command to cancel changes caused by the previous command.
*/
readonly undo: UndoCommand;
/**
* Gets a command to reverse actions of the previous RichEditCommands.undo command.
*/
readonly redo: RedoCommand;
/**
* Gets a command to copy the selected text and place it to the clipboard.
*/
readonly copy: CopyCommand;
/**
* Gets a command to paste the text from the clipboard over the selection.
*/
readonly paste: PasteCommand;
/**
* Gets a command to cut the selected text and place it to the clipboard.
*/
readonly cut: CutCommand;
/**
* Gets a command to change the font name of characters in a selected range.
*/
readonly changeFontName: ChangeFontNameCommand;
/**
* Gets a command to change the font size (in points) of characters in a selected range.
*/
readonly changeFontSize: ChangeFontSizeCommand;
/**
* Gets a command to increase the font size of characters in a selected range to the closest larger predefined value (in points).
*/
readonly increaseFontSize: IncreaseFontSizeCommand;
/**
* Gets a command to decrease the selected range's font size to the closest smaller predefined value (in points).
*/
readonly decreaseFontSize: DecreaseFontSizeCommand;
/**
* Gets a command to convert selected text to upper case.
*/
readonly makeTextUpperCase: MakeTextUpperCaseCommand;
/**
* Gets a command to convert selected text to lower case.
*/
readonly makeTextLowerCase: MakeTextLowerCaseCommand;
/**
* Gets a command to capitalize each word in the selected sentence.
*/
readonly capitalizeEachWordTextCase: CapitalizeEachWordTextCaseCommand;
/**
* Gets a command to toggle case for each character - upper case becomes lower, lower case becomes upper.
*/
readonly toggleTextCase: ToggleTextCaseCommand;
/**
* Gets a command to change the bold formatting of characters in a selected range.
*/
readonly changeFontBold: ChangeFontBoldCommand;
/**
* Gets a command to change the italic formatting of characters in a selected range.
*/
readonly changeFontItalic: ChangeFontItalicCommand;
/**
* Gets a command to change the underline formatting of characters in a selected range.
*/
readonly changeFontUnderline: ChangeFontUnderlineCommand;
/**
* Gets a command to change the strikeout formatting of characters in a selected range.
*/
readonly changeFontStrikeout: ChangeFontStrikeoutCommand;
/**
* Gets a command to change the superscript formatting of characters in a selected range.
*/
readonly changeFontSuperscript: ChangeFontSuperscriptCommand;
/**
* Gets a command to change the subscript formatting of characters in a selected range.
*/
readonly changeFontSubscript: ChangeFontSubscriptCommand;
/**
* Gets a command to change the font color of characters in a selected range.
*/
readonly changeFontForeColor: ChangeFontForeColorCommand;
/**
* Gets a command to change the background color of characters in a selected range.
*/
readonly changeFontBackColor: ChangeFontBackColorCommand;
/**
* Gets a command to reset textual and paragraph formatting in the selected range to default values.
*/
readonly clearFormatting: ClearFormattingCommand;
/**
* Gets a command to apply a character or paragraph style settings to text in a selected range.
*/
readonly changeStyle: ChangeStyleCommand;
/**
* Gets a command to toggle between the bulleted paragraph and normal text.
*/
readonly toggleBulletedList: ToggleBulletedListCommand;
/**
* Gets a command to toggle between the numbered paragraph and normal text.
*/
readonly toggleNumberingList: ToggleNumberingListCommand;
/**
* Gets a command to toggle between the multilevel list style and normal text.
*/
readonly toggleMultilevelList: ToggleMultilevelListCommand;
/**
* Gets a command to increment the indent level of paragraphs in a selected range.
*/
readonly increaseIndent: IncreaseIndentCommand;
/**
* Gets a command to decrease the indent level of paragraphs in a selected range.
*/
readonly decreaseIndent: DecreaseIndentCommand;
/**
* Gets a command to toggle hidden symbol visibility.
*/
readonly showHiddenSymbols: ShowHiddenSymbolsCommand;
/**
* Gets a command to toggle left paragraph alignment on and off.
*/
readonly toggleParagraphAlignmentLeft: ToggleParagraphAlignmentLeftCommand;
/**
* Gets a command to toggle centered paragraph alignment on and off.
*/
readonly toggleParagraphAlignmentCenter: ToggleParagraphAlignmentCenterCommand;
/**
* Gets a command to toggle right paragraph alignment on and off.
*/
readonly toggleParagraphAlignmentRight: ToggleParagraphAlignmentRightCommand;
/**
* Gets a command to toggle justified paragraph alignment on and off.
*/
readonly toggleParagraphAlignmentJustify: ToggleParagraphAlignmentJustifyCommand;
/**
* Gets a command to format a current paragraph with single line spacing.
*/
readonly setSingleParagraphSpacing: SetSingleParagraphSpacingCommand;
/**
* Gets a command to format a current paragraph with one and a half line spacing.
*/
readonly setSesquialteralParagraphSpacing: SetSesquialteralParagraphSpacingCommand;
/**
* Gets a command to format a selected paragraph with double line spacing.
*/
readonly setDoubleParagraphSpacing: SetDoubleParagraphSpacingCommand;
/**
* Gets a command to add spacing before a paragraph.
*/
readonly addSpacingBeforeParagraph: AddSpacingBeforeParagraphCommand;
/**
* Gets a command to add spacing after a paragraph.
*/
readonly addSpacingAfterParagraph: AddSpacingAfterParagraphCommand;
/**
* Gets a command to remove spacing before the selected paragraph.
*/
readonly removeSpacingBeforeParagraph: RemoveSpacingBeforeParagraphCommand;
/**
* Gets a command to remove spacing after the selected paragraph.
*/
readonly removeSpacingAfterParagraph: RemoveSpacingAfterParagraphCommand;
/**
* Gets a command to change the background color of paragraphs in a selected range.
*/
readonly changeParagraphBackColor: ChangeParagraphBackColorCommand;
/**
* Gets a command to invoke the Font dialog window.
*/
readonly openFontFormattingDialog: OpenFontFormattingDialogCommand;
/**
* Gets a command to change the font formatting of characters in a selected range.
*/
readonly changeFontFormatting: ChangeFontFormattingCommand;
/**
* Gets a command to invoke the Indents And Spacing tab of the Paragraph dialog window.
*/
readonly openParagraphFormattingDialog: OpenParagraphFormattingDialogCommand;
/**
* Gets a command to apply formatting settings to paragraphs within a selected range.
*/
readonly changeParagraphFormatting: ChangeParagraphFormattingCommand;
/**
* Gets a command to insert a page break at the current position in the document.
*/
readonly insertPageBreak: InsertPageBreakCommand;
/**
* Gets a command to invoke the Insert Table dialog window.
*/
readonly openInsertTableDialog: OpenInsertTableDialogCommand;
/**
* Gets a command to insert a rectangular table of the specified size.
*/
readonly insertTable: InsertTableCommand;
/**
* Gets a command to invoke the Insert Image dialog window.
*/
readonly openInsertPictureDialog: OpenInsertPictureDialogCommand;
/**
* Gets a command to insert an inline picture stored by the specified web address.
*/
readonly insertPicture: InsertPictureCommand;
/**
* Gets a command to invoke the Bookmark dialog window.
*/
readonly openInsertBookmarkDialog: OpenInsertBookmarkDialogCommand;
/**
* Gets a command to insert a new bookmark that references the current selection.
*/
readonly insertBookmark: InsertBookmarkCommand;
/**
* Gets a command to delete a specific bookmark.
*/
readonly deleteBookmark: DeleteBookmarkCommand;
/**
* Gets a command to navigate to the specified bookmark.
*/
readonly goToBookmark: GoToBookmarkCommand;
/**
* Gets a command to invoke the Hyperlink dialog window.
*/
readonly openInsertHyperlinkDialog: OpenInsertHyperlinkDialogCommand;
/**
* Gets a command to insert and update a hyperlink field in place of a selected range.
*/
readonly insertHyperlink: InsertHyperlinkCommand;
/**
* Gets a command to delete the selected hyperlink.
*/
readonly deleteHyperlink: DeleteHyperlinkCommand;
/**
* Gets a command to delete all hyperlinks in the selected range.
*/
readonly deleteHyperlinks: DeleteHyperlinksCommand;
/**
* Gets a command to go to a bookmark or URI contained within the selected hyperlink.
*/
readonly openHyperlink: OpenHyperlinkCommand;
/**
* Gets a command to invoke the Symbols dialog window.
*/
readonly openInsertSymbolDialog: OpenInsertSymbolDialogCommand;
/**
* Gets a command to insert characters into a document instead of a selected range.
*/
readonly insertSymbol: InsertSymbolCommand;
/**
* Gets a command to apply page margins settings to sections located within a selected range.
*/
readonly changePageMargins: ChangePageMarginsCommand;
/**
* Gets a command to invoke the Margins tab of the Page Setup dialog window.
*/
readonly openPageMarginsDialog: OpenPageMarginsDialogCommand;
/**
* Gets a command to apply page orientation settings to sections located within a selected range.
*/
readonly changePageOrientation: ChangePageOrientationCommand;
/**
* Gets a command to invoke the Page Setup dialog.
*/
readonly setPageSizeDialog: SetPageSizeDialogCommand;
/**
* Gets a command to invoke the Paper tab of the Page Setup dialog window.
*/
readonly openPagePaperSizeDialog: OpenPagePaperSizeDialogCommand;
/**
* Gets a command to apply page size settings to sections located within a selected range.
*/
readonly changePageSize: ChangePageSizeCommand;
/**
* Gets a command to change the number of columns having the same width in a section.
*/
readonly changeSectionEqualColumnCount: ChangeSectionEqualColumnCountCommand;
/**
* Gets a command to invoke the Columns dialog window.
*/
readonly openSectionColumnsDialog: OpenSectionColumnsDialogCommand;
/**
* Gets a command to apply column layout settings to a section.
*/
readonly changeSectionColumns: ChangeSectionColumnsCommand;
/**
* Gets a command to insert a column break at the current position in the document.
*/
readonly insertColumnBreak: InsertColumnBreakCommand;
/**
* Gets a command to insert a section break and starts a new section on the next page.
*/
readonly insertSectionBreakNextPage: InsertSectionBreakNextPageCommand;
/**
* Gets a command to insert a section break and starts a new section on the next even-numbered page.
*/
readonly insertSectionBreakEvenPage: InsertSectionBreakEvenPageCommand;
/**
* Gets a command to insert a section break and starts a new section on the next odd-numbered page.
*/
readonly insertSectionBreakOddPage: InsertSectionBreakOddPageCommand;
/**
* Gets a command to set the background color of all pages contained in the document.
*/
readonly changePageColor: ChangePageColorCommand;
/**
* Gets a command to toggle the horizontal ruler's visibility.
*/
readonly showHorizontalRuler: ShowHorizontalRulerCommand;
/**
* Gets a command to toggle the fullscreen mode.
*/
readonly setFullscreen: SetFullscreenCommand;
/**
* Gets a command to change the Rich Edit's document view type.
*/
readonly changeViewType: ChangeViewTypeCommand;
/**
* Gets a command to force synchronizing the server document model with the client model and execute a callback function if it is necessary.
*/
readonly forceSyncWithServer: ForceSyncWithServerCommand;
/**
* Gets a command to insert content created on the server to the client model.
*/
readonly insertContentFromServer: InsertContentFromServerCommand;
/**
* Gets a command to invoke the Bulleted and Numbering dialog window.
*/
readonly openNumberingListDialog: OpenNumberingListDialogCommand;
/**
* Gets a command to insert a paragraph break at the current position in the document.
*/
readonly insertParagraph: InsertParagraphCommand;
/**
* Gets a command to insert text in place of a selected range.
*/
readonly insertText: InsertTextCommand;
/**
* Gets a command to delete text and in-line objects in a selected range.
*/
readonly delete: DeleteCommand;
/**
* Gets a command to remove the previous word.
*/
readonly removePrevWord: RemovePrevWordCommand;
/**
* Gets a command to remove the next word.
*/
readonly removeNextWord: RemoveNextWordCommand;
/**
* Gets a command to move the cursor backwards and erase characters in a selected range.
*/
readonly backspace: BackspaceCommand;
/**
* Gets a command to insert the line break at the current position in the document.
*/
readonly insertLineBreak: InsertLineBreakCommand;
/**
* Gets a command to scale a selected in-line picture.
*/
readonly changePictureScale: ChangePictureScaleCommand;
/**
* Gets a command to increment the left indent of paragraphs in a selected range.
*/
readonly incrementParagraphLeftIndent: IncrementParagraphLeftIndentCommand;
/**
* Gets a command to decrement the paragraph's left indent position.
*/
readonly decrementParagraphLeftIndent: DecrementParagraphLeftIndentCommand;
/**
* Gets a command to move the selected range.
*/
readonly moveContent: MoveContentCommand;
/**
* Gets a command to copy the selected text and place it to the specified position.
*/
readonly copyContent: CopyContentCommand;
/**
* Gets a command to insert a tab character at the current position in the document.
*/
readonly insertTab: InsertTabCommand;
/**
* Gets a command to add a non-breaking space in place of a selected range
*/
readonly insertNonBreakingSpace: InsertNonBreakingSpaceCommand;
/**
* Gets a command to invoke the Tabs dialog window.
*/
readonly openTabsDialog: OpenTabsDialogCommand;
/**
* Gets a command to change the default tab stop value of a document and apply custom tab settings to the selected paragraphs.
*/
readonly changeTabs: ChangeTabsCommand;
/**
* Gets a command to invoke the Customize Numbered List dialog window.
*/
readonly openCustomNumberingListDialog: OpenCustomNumberingListDialogCommand;
/**
* Gets a command to customize the numbered list parameters.
*/
readonly changeCustomNumberingList: ChangeCustomNumberingListCommand;
/**
* Gets a command to restart the numbering list.
*/
readonly restartNumberingList: RestartNumberingListCommand;
/**
* Gets a command to increment the indent level of paragraphs in a selected numbered list.
*/
readonly incrementNumberingIndent: IncrementNumberingIndentCommand;
/**
* Gets a command to decrement the indent level of paragraphs in a selected numbered list.
*/
readonly decrementNumberingIndent: DecrementNumberingIndentCommand;
/**
* Gets a command to add a field at the current position in a document.
*/
readonly createField: CreateFieldCommand;
/**
* Gets a command to update each field's result in the selection.
*/
readonly updateField: UpdateFieldCommand;
/**
* Gets a command to display the selected field's codes.
*/
readonly showFieldCodes: ShowFieldCodesCommand;
/**
* Gets a command to display all field codes in place of the fields in the document.
*/
readonly showAllFieldCodes: ShowAllFieldCodesCommand;
/**
* Gets a command to continue the list's numbering.
*/
readonly continueNumberingList: ContinueNumberingListCommand;
/**
* Gets a command to insert numeration to a paragraph making it a numbering list item.
*/
readonly insertNumeration: InsertNumerationCommand;
/**
* Gets a command to exclude the selected paragraphs from the numbered list.
*/
readonly removeNumeration: RemoveNumerationCommand;
/**
* Gets a command to update all fields in the document.
*/
readonly updateAllFields: UpdateAllFieldsCommand;
/**
* Gets a command to insert and update a field with a DATE code.
*/
readonly createDateField: CreateDateFieldCommand;
/**
* Gets a command to replace the selection with a TIME field displaying the current time.
*/
readonly createTimeField: CreateTimeFieldCommand;
/**
* Gets a command to replace the selection with a PAGE field displaying the current page number.
*/
readonly createPageField: CreatePageFieldCommand;
/**
* Gets a command to add a caption (numbered label) to a figure.
*/
readonly insertFiguresCaption: InsertFiguresCaptionCommand;
/**
* Gets a command to add a caption (numbered label) to a table.
*/
readonly insertTablesCaption: InsertTablesCaptionCommand;
/**
* Gets a command to add a caption (numbered label) to an equation.
*/
readonly insertEquationsCaption: InsertEquationsCaptionCommand;
/**
* Gets a command to create a table of figures on the base of figures captions.
*/
readonly insertTableOfFigures: InsertTableOfFiguresCommand;
/**
* Gets a command to create a table of tables on the base of tables captions.
*/
readonly insertTableOfTables: InsertTableOfTablesCommand;
/**
* Gets a command to create a table of equations on the base of equation captions.
*/
readonly insertTableOfEquations: InsertTableOfEquationsCommand;
/**
* Gets a command to insert a table of contents.
*/
readonly insertTableOfContents: InsertTableOfContentsCommand;
/**
* Gets a command that changes the specified hyperlink.
*/
readonly changeHyperlink: ChangeHyperlinkCommand;
/**
* Gets a command to update a table of contents.
*/
readonly updateTableOfContents: UpdateTableOfContentsCommand;
/**
* Gets a command to apply a paragraph level to the selected text
*/
readonly setParagraphLevel: SetParagraphLevelCommand;
/**
* Gets a command changing all selected text to the sentence case capitalization.
*/
readonly makeTextSentenceCase: MakeTextSentenceCaseCommand;
/**
* Gets a command to switch the text capitalization in the selection.
*/
readonly switchTextCase: SwitchTextCaseCommand;
/**
* Gets a command to navigate to the first data record.
*/
readonly goToFirstDataRecord: GoToFirstDataRecordCommand;
/**
* Gets a command to navigate to the previous data record of the bound data source.
*/
readonly goToPreviousDataRecord: GoToPreviousDataRecordCommand;
/**
* Gets a command to navigate to the next data record of the bound data source.
*/
readonly goToNextDataRecord: GoToNextDataRecordCommand;
/**
* Gets a command to open the specified data record.
*/
readonly goToDataRecord: GoToDataRecordCommand;
/**
* Gets a command to navigate to the last data record of the bound data source.
*/
readonly goToLastDataRecord: GoToLastDataRecordCommand;
/**
* Gets a command to display or hide actual data in MERGEFIELD fields.
*/
readonly showMergedData: ShowMergedDataCommand;
/**
* Gets a command to invoke the Insert Merge Field dialog window.
*/
readonly mergeFieldDialog: MergeFieldDialogCommand;
/**
* Gets a command to replace the selection with a MERGEFIELD (a data source column name is passed with a parameter).
*/
readonly createMergeField: CreateMergeFieldCommand;
/**
* Gets a command to invoke the Export Range dialog window to start a mail merge.
*/
readonly mailMergeDialog: MailMergeDialogCommand;
/**
* Gets a command to perform a mail merge and download the merged document.
*/
readonly mailMergeAndDownload: MailMergeAndDownloadCommand;
/**
* Gets a command to perform a mail merge and save the merged document to the server.
*/
readonly mailMergeAndSaveAs: MailMergeAndSaveAsCommand;
/**
* 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.
*/
readonly insertHeader: InsertHeaderCommand;
/**
* 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.
*/
readonly insertFooter: InsertFooterCommand;
/**
* Gets a command to link a header/footer to the previous section, so it has the same content.
*/
readonly linkHeaderFooterToPrevious: LinkHeaderFooterToPreviousCommand;
/**
* Gets a command to substitute a header sub-document with a footer sub-document of the same page as an active sub-document.
*/
readonly goToFooter: GoToFooterCommand;
/**
* Gets a command to substitute a footer sub-document with a header sub-document of the same page as an active sub-document.
*/
readonly goToHeader: GoToHeaderCommand;
/**
* Gets a command to substitute a current header/footer with a header/footer of the next section as an active sub-document.
*/
readonly goToNextHeaderFooter: GoToNextHeaderFooterCommand;
/**
* Gets a command to substitute a current header/footer with a header/footer of the previous section as an active sub-document.
*/
readonly goToPreviousHeaderFooter: GoToPreviousHeaderFooterCommand;
/**
* 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.
*/
readonly setDifferentFirstPageHeaderFooter: SetDifferentFirstPageHeaderFooterCommand;
/**
* 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.
*/
readonly setDifferentOddAndEvenPagesHeaderFooter: SetDifferentOddAndEvenPagesHeaderFooterCommand;
/**
* Gets a command to substitute a header/footer sub-document with the main sub-document as an active sub-document.
*/
readonly closeHeaderFooter: CloseHeaderFooterCommand;
/**
* Gets a command to replace the selection with a NUMPAGES field displaying the total number of pages.
*/
readonly createPageCountField: CreatePageCountFieldCommand;
/**
* Gets a command to invoke the Table tab of the Table Properties dialog window.
*/
readonly openTableFormattingDialog: OpenTableFormattingDialogCommand;
/**
* Gets a command to change the selected table's formatting.
*/
readonly changeTableFormatting: ChangeTableFormattingCommand;
/**
* Gets a command to change the selected table rows' preferred height.
*/
readonly changeTableRowPreferredHeight: ChangeTableRowPreferredHeightCommand;
/**
* Gets a command to change the preferred cell width of the selected table rows.
*/
readonly changeTableCellPreferredWidth: ChangeTableCellPreferredWidthCommand;
/**
* Gets a command to apply (or cancel) border settings of the inside borders for the selected cells.
*/
readonly toggleTableCellInsideBorders: ToggleTableCellInsideBordersCommand;
/**
* Gets a command to change the selected table columns' preferred width.
*/
readonly changeTableColumnPreferredWidth: ChangeTableColumnPreferredWidthCommand;
/**
* Gets a command to change the cell formatting of the selected table elements.
*/
readonly changeTableCellFormatting: ChangeTableCellFormattingCommand;
/**
* Gets a command to insert a table column to the left of the current position in the table.
*/
readonly insertTableColumnToTheLeft: InsertTableColumnToTheLeftCommand;
/**
* Gets a command to insert a table column to the right of the current position in the table.
*/
readonly insertTableColumnToTheRight: InsertTableColumnToTheRightCommand;
/**
* Gets a command to insert a row in the table below the selected row.
*/
readonly insertTableRowBelow: InsertTableRowBelowCommand;
/**
* Gets a command to insert a row in the table above the selected row.
*/
readonly insertTableRowAbove: InsertTableRowAboveCommand;
/**
* Gets a command to delete the selected rows in the table.
*/
readonly deleteTableRows: DeleteTableRowsCommand;
/**
* Gets a command to delete the selected columns in the table.
*/
readonly deleteTableColumns: DeleteTableColumnsCommand;
/**
* Gets a command to insert table cells with a horizontal shift into the selected table.
*/
readonly insertTableCellWithShiftToTheLeft: InsertTableCellWithShiftToTheLeftCommand;
/**
* Gets a command to delete the selected table cells with a horizontal shift.
*/
readonly deleteTableCellsWithShiftHorizontally: DeleteTableCellsWithShiftHorizontallyCommand;
/**
* Gets a command to delete the selected table cells with a vertical shift.
*/
readonly deleteTableCellsWithShiftVertically: DeleteTableCellsWithShiftVerticallyCommand;
/**
* Gets a command to delete the selected table.
*/
readonly deleteTable: DeleteTableCommand;
/**
* Gets a command to invoke the Insert Cells dialog window.
*/
readonly insertTableCellsDialog: InsertTableCellsDialogCommand;
/**
* Gets a command to invoke the Delete Cells dialog window.
*/
readonly deleteTableCellsDialog: DeleteTableCellsDialogCommand;
/**
* Gets a command to merge the selected cells.
*/
readonly mergeTableCells: MergeTableCellsCommand;
/**
* Gets a command to invoke the Split Cells dialog window.
*/
readonly splitTableCellsDialog: SplitTableCellsDialogCommand;
/**
* Gets a command to split the selected table cells.
*/
readonly splitTableCells: SplitTableCellsCommand;
/**
* Gets a command to insert table cells with a vertical shift into the selected table.
*/
readonly insertTableCellsWithShiftToTheVertically: InsertTableCellsWithShiftToTheVerticallyCommand;
/**
* Gets a command to invoke the Borders tab of the Borders and Shading dialog window.
*/
readonly openTableBordersAndShadingDialog: OpenTableBordersAndShadingDialogCommand;
/**
* Gets a command to change the selected table's borders and shading.
*/
readonly changeTableBordersAndShading: ChangeTableBordersAndShadingCommand;
/**
* Gets a command to apply top-left alignment for the selected cells.
*/
readonly toggleTableCellAlignTopLeft: ToggleTableCellAlignTopLeftCommand;
/**
* Gets a command to apply top-center alignment for the selected cells.
*/
readonly toggleTableCellAlignTopCenter: ToggleTableCellAlignTopCenterCommand;
/**
* Gets a command to apply top-right alignment for the selected cells.
*/
readonly toggleTableCellAlignTopRight: ToggleTableCellAlignTopRightCommand;
/**
* Gets a command to apply middle-left alignment for the selected cells.
*/
readonly toggleTableCellAlignMiddleLeft: ToggleTableCellAlignMiddleLeftCommand;
/**
* Gets a command to apply middle-center alignment for the selected cells.
*/
readonly toggleTableCellAlignMiddleCenter: ToggleTableCellAlignMiddleCenterCommand;
/**
* Gets a command to apply middle-right alignment for the selected cells.
*/
readonly toggleTableCellAlignMiddleRight: ToggleTableCellAlignMiddleRightCommand;
/**
* Gets a command to apply bottom-left alignment for the selected cells.
*/
readonly toggleTableCellAlignBottomLeft: ToggleTableCellAlignBottomLeftCommand;
/**
* Gets a command to apply bottom-center alignment for the selected cells.
*/
readonly toggleTableCellAlignBottomCenter: ToggleTableCellAlignBottomCenterCommand;
/**
* Gets a command to apply bottom-right alignment for the selected cells.
*/
readonly toggleTableCellAlignBottomRight: ToggleTableCellAlignBottomRightCommand;
/**
* Gets a command to change the selected table's style.
*/
readonly changeTableStyle: ChangeTableStyleCommand;
/**
* Gets a command to apply (or cancel) border settings of the top border for the selected cells.
*/
readonly toggleTableCellTopBorder: ToggleTableCellTopBorderCommand;
/**
* Gets a command to apply (or cancel) border settings of the right border for the selected cells.
*/
readonly toggleTableCellRightBorder: ToggleTableCellRightBorderCommand;
/**
* Gets a command to apply (or cancel) border settings of the bottom border for the selected cells.
*/
readonly toggleTableCellBottomBorder: ToggleTableCellBottomBorderCommand;
/**
* Gets a command to apply (or cancel) border settings of the left border for the selected cells.
*/
readonly toggleTableCellLeftBorder: ToggleTableCellLeftBorderCommand;
/**
* Gets a command to remove the borders of the selected table cells.
*/
readonly removeTableCellBorders: RemoveTableCellBordersCommand;
/**
* Gets a command to apply (or cancel) border settings to all borders of the selected cells.
*/
readonly toggleTableCellAllBorders: ToggleTableCellAllBordersCommand;
/**
* Gets a command to apply (or cancel) border settings of the inside horizontal borders for the selected cells.
*/
readonly toggleTableCellInsideHorizontalBorders: ToggleTableCellInsideHorizontalBordersCommand;
/**
* Gets a command to apply (or cancel) border settings of the inside vertical borders for the selected cells.
*/
readonly toggleTableCellInsideVerticalBorders: ToggleTableCellInsideVerticalBordersCommand;
/**
* Gets a command to apply (or cancel) border settings of the outside borders for the selected cells.
*/
readonly toggleTableCellOutsideBorders: ToggleTableCellOutsideBordersCommand;
/**
* Gets a command to change the selected table's style options.
*/
readonly changeTableLook: ChangeTableLookCommand;
/**
* Gets a command to apply borders' drawing settings.
*/
readonly changeTableBorderRepositoryItem: ChangeTableBorderRepositoryItemCommand;
/**
* Gets a command to change cell shading in selected table cells.
*/
readonly changeTableCellShading: ChangeTableCellShadingCommand;
/**
* Gets a command to toggle the display of grid lines for a table with no borders applied - on/off.
*/
readonly showTableGridLines: ShowTableGridLinesCommand;
/**
* Gets a command that fits the specified table to its contents.
*/
readonly toggleTableAutoFitContents: ToggleTableAutoFitContentsCommand;
/**
* Gets a command that fits the specified table to a document's window.
*/
readonly toggleTableAutoFitWindow: ToggleTableAutoFitWindowCommand;
/**
* Gets a command that disables automatic adjusting of the selected table.
*/
readonly toggleTableFixedColumnWidth: ToggleTableFixedColumnWidthCommand;
/**
* Gets a command to invoke the Search Panel allowing end-users to search text and navigate through search results.
*/
readonly openFindPanel: OpenFindPanelCommand;
/**
* Gets a command to invoke the Find and Replace dialog window.
*/
readonly openFindAndReplaceDialog: OpenFindAndReplaceDialogCommand;
/**
* Gets a command to find all matches of the specified text in the document.
*/
readonly findAll: FindAllCommand;
/**
* Gets a command to hide the search results.
*/
readonly hideFindResults: HideFindResultsCommand;
/**
* Gets a command to replace all matches of the specified text with new characters.
*/
readonly replaceAll: ReplaceAllCommand;
/**
* Gets a command to find and replace a next match of the specified text after the cursor position with new characters.
*/
readonly replaceNext: ReplaceNextCommand;
/**
* Gets a command to invoke the Spelling dialog window.
*/
readonly openSpellingDialog: OpenSpellingDialogCommand;
/**
* Gets a command to assign a shortcut to the specified client command.
*/
readonly assignShortcut: AssignShortcutCommand;
/**
* Gets a command to invoke the Layout dialog window to customize the settings of a floating object.
*/
readonly openLayoutOptionsDialog: OpenLayoutOptionsDialogCommand;
/**
* Gets a command to insert a floating text box.
*/
readonly insertFloatingTextBox: InsertFloatingTextBoxCommand;
/**
* Gets a command to modify a floating object's alignment position.
*/
readonly changeFloatingObjectAlignmentPosition: ChangeFloatingObjectAlignmentPositionCommand;
/**
* Gets a command to change a floating object's absolute position.
*/
readonly changeFloatingObjectAbsolutePosition: ChangeFloatingObjectAbsolutePositionCommand;
/**
* Gets a command to modify a floating object's relative position.
*/
readonly changeFloatingObjectRelativePosition: ChangeFloatingObjectRelativePositionCommand;
/**
* Gets a command to lock a floating object's anchor.
*/
readonly changeFloatingObjectLockAnchor: ChangeFloatingObjectLockAnchorCommand;
/**
* Gets a command to modify a floating object's text wrapping settings.
*/
readonly changeFloatingObjectTextWrapping: ChangeFloatingObjectTextWrappingCommand;
/**
* Gets a command to change a floating object's absolute size.
*/
readonly changeFloatingObjectAbsoluteSize: ChangeFloatingObjectAbsoluteSizeCommand;
/**
* Gets a command to modify a text box's relative size settings.
*/
readonly changeTextBoxRelativeSize: ChangeTextBoxRelativeSizeCommand;
/**
* Gets a command to rotate a floating object.
*/
readonly changeFloatingObjectRotation: ChangeFloatingObjectRotationCommand;
/**
* Gets a command to lock a floating object's aspect ratio.
*/
readonly changeFloatingObjectLockAspectRatio: ChangeFloatingObjectLockAspectRatioCommand;
/**
* Gets a command to modify a floating object's background fill color.
*/
readonly changeFloatingObjectFillColor: ChangeFloatingObjectFillColorCommand;
/**
* Gets a command to modify a floating object's outline color.
*/
readonly changeFloatingObjectOutlineColor: ChangeFloatingObjectOutlineColorCommand;
/**
* Gets a command to modify a floating object's outline width.
*/
readonly changeFloatingObjectOutlineWidth: ChangeFloatingObjectOutlineWidthCommand;
/**
* Gets a command to modify a text box's content margins.
*/
readonly changeTextBoxContentMargins: ChangeTextBoxContentMarginsCommand;
/**
* Gets a command to resize the shape to fit the text in the text box.
*/
readonly changeTextBoxResizeShapeToFitText: ChangeTextBoxResizeShapeToFitTextCommand;
/**
* Gets a command to add an HTML formatted content in place of a selected range.
*/
readonly insertHtml: InsertHtmlCommand;
/**
* Gets a command to add RTF formatted content at the specified position.
*/
readonly insertRtf: InsertRtfCommand;
/**
* Gets a command to receive RTF formatted content from the document in the specified range.
*/
readonly getRtf: GetRtfCommand;
}
/**
* Provides data for the ASPxClientRichEdit.AutoCorrect event.
*/
declare class ASPxClientRichEditAutoCorrectEventArgs extends ASPxClientEventArgs {
/**
* Specifies whether the event is handled.
*/
handled: boolean;
/**
* Gets the input string to check whether it should be replaced.
*/
text: string;
/**
* Gets the input string's interval.
*/
interval: Interval;
/**
* Initializes a new instance of the ASPxClientRichEditAutoCorrectEventArgs object. For internal use only.
* @param text The input string to check whether it should be replaced.
* @param interval The Interval object specifying the input string.
* @param handled true if the event is handled and no default processing is required; otherwise false.
*/
constructor(text: any, interval: any, handled: any);
}
/**
* Provides data for the ASPxClientRichEdit.CharacterPropertiesChanged event.
*/
declare class ASPxClientRichEditCharacterPropertiesChangedEventArgs extends ASPxClientEventArgs {
/**
* Gets the active sub-document's identifier.
*/
subDocumentId: number;
/**
* Gets the text buffer interval related to the changed characters.
*/
interval: Interval;
/**
* Initializes a new instance of the ASPxClientRichEditCharacterPropertiesChangedEventArgs object. For internal use only.
* @param subDocumentId An identifier of a sub-document containing the changed characters.
* @param interval An interval object that relates to the changed characters.
*/
constructor(subDocumentId: number, interval: Interval);
}
/**
* Provides data for the ASPxClientRichEdit.ContentInserted event.
*/
declare class ASPxClientRichEditContentInsertedEventArgs extends ASPxClientEventArgs {
/**
* Gets the active sub-document's identifier.
*/
subDocumentId: number;
/**
* Gets the text buffer interval related to the inserted content.
*/
interval: Interval;
/**
* Initializes a new instance of the ASPxClientRichEditContentInsertedEventArgs object. For internal use only.
* @param subDocumentId An identifier of a sub-document that contains the inserted content.
* @param interval An interval object that relates to the inserted content.
*/
constructor(subDocumentId: number, interval: Interval);
}
/**
* Provides data for the ASPxClientRichEdit.ContentRemoved event.
*/
declare class ASPxClientRichEditContentRemovedEventArgs extends ASPxClientEventArgs {
/**
* Gets the active sub-document's identifier.
*/
subDocumentId: number;
/**
* Gets the text buffer interval related to the removed content.
*/
interval: Interval;
/**
* Initializes a new instance of the ASPxClientRichEditContentRemovedEventArgs object. For internal use only.
* @param subDocumentId An identifier of a sub-document that contained the removed content.
* @param interval An interval object that relates to the removed content.
*/
constructor(subDocumentId: number, interval: Interval);
}
/**
* Provides data for the ASPxClientRichEdit.CustomCommandExecuted event.
*/
declare class ASPxClientRichEditCustomCommandExecutedEventArgs extends ASPxClientEventArgs {
/**
* Gets the name of the processed command.
*/
commandName: string;
/**
* Gets an optional parameter that complements the processed command.
*/
parameter: any;
/**
* Initializes a new instance of the ASPxClientRichEditCustomCommandExecutedEventArgs object. For internal use only.
* @param commandName A string value that specifies the name of the processed command.
* @param parameter An object that can contain command specific information needed for handling the command execution.
*/
constructor(commandName: string, parameter: any);
}
/**
* Provides data for the ASPxClientRichEdit.DocumentFormatted event.
*/
declare class ASPxClientRichEditDocumentFormattedEventArgs extends ASPxClientEventArgs {
/**
* Gets the number of pages in the document.
*/
pageCount: number;
/**
* Initializes a new instance of the ASPxClientRichEditDocumentFormattedEventArgs object. For internal use only.
* @param pageCount The number of pages in the document.
*/
constructor(pageCount: number);
}
/**
* Provides data for the ASPxClientRichEdit.HyperlinkClick event.
*/
declare class ASPxClientRichEditHyperlinkClickEventArgs extends ASPxClientEventArgs {
/**
* Gets or sets whether the event is handled manually, so no default processing is required.
*/
handled: boolean;
/**
* Gets a DHTML event object that relates to the processed event.
*/
htmlEvent: any;
/**
* Gets a value identifying the clicked hyperlink type.
*/
hyperlinkType: ASPxClientOfficeDocumentLinkType;
/**
* Gets the clicked link's URI.
*/
targetUri: string;
/**
* Initializes a new instance of the ASPxClientRichEditHyperlinkClickEventArgs object. For internal use only.
* @param htmlEvent A DHTML event object that relates to the processed event.
* @param handled true if the event is handled and no default processing is required; otherwise false.
* @param targetUri The target URI.
* @param hyperlinkType The document link type.
*/
constructor(htmlEvent: any, handled: boolean, targetUri: string, hyperlinkType: ASPxClientOfficeDocumentLinkType);
}
/**
* Provides data for the ASPxClientRichEdit.KeyDown event.
*/
declare class ASPxClientRichEditKeyDownEventArgs extends ASPxClientEventArgs {
/**
* Gets or sets whether the event is handled manually, so no default processing is required.
*/
handled: boolean;
/**
* Gets a DHTML event object that relates to the processed event.
*/
htmlEvent: any;
/**
* Initializes a new instance of the ASPxClientRichEditKeyDownEventArgs object. For internal use only.
* @param htmlEvent A DHTML event object that relates to the processed event.
* @param handled true if the event is handled and no default processing is required; otherwise false.
*/
constructor(htmlEvent: any, handled: boolean);
}
/**
* Provides data for the ASPxClientRichEdit.KeyUp event.
*/
declare class ASPxClientRichEditKeyUpEventArgs extends ASPxClientEventArgs {
/**
* Gets a DHTML event object that relates to the processed event.
*/
htmlEvent: any;
/**
* Initializes a new instance of the ASPxClientRichEditKeyUpEventArgs object. For internal use only.
* @param htmlEvent A DHTML event object that relates to the processed event.
*/
constructor(htmlEvent: any);
}
/**
* Provides data for the ASPxClientRichEdit.ParagraphPropertiesChanged event.
*/
declare class ASPxClientRichEditParagraphPropertiesChangedEventArgs extends ASPxClientEventArgs {
/**
* Gets the active sub-document's identifier.
*/
subDocumentId: number;
/**
* Gets the changed paragraph's index.
*/
paragraphIndex: number;
/**
* Initializes a new instance of the ASPxClientRichEditParagraphPropertiesChangedEventArgs object. For internal use only.
* @param subDocumentId An identifier of a sub-document containing the changed paragraph.
* @param paragraphIndex The changed paragraph's index.
*/
constructor(subDocumentId: number, paragraphIndex: number);
}
/**
* Provides data for the ASPxClientRichEdit.PointerDown event.
*/
declare class ASPxClientRichEditPointerDownEventArgs extends ASPxClientEventArgs {
/**
* Gets or sets whether the event is handled manually, so no default processing is required.
*/
handled: boolean;
/**
* Gets a DHTML event object that relates to the processed event.
*/
htmlEvent: any;
/**
* Initializes a new instance of the ASPxClientRichEditPointerDownEventArgs object. For internal use only.
* @param htmlEvent A DHTML event object that relates to the processed event.
* @param handled true if the event is handled and no default processing is required; otherwise false.
*/
constructor(htmlEvent: any, handled: boolean);
}
/**
* Provides data for the ASPxClientRichEdit.PointerUp event.
*/
declare class ASPxClientRichEditPointerUpEventArgs extends ASPxClientEventArgs {
/**
* Gets or sets whether the event is handled manually, so no default processing is required.
*/
handled: boolean;
/**
* Gets a DHTML event object that relates to the processed event.
*/
htmlEvent: any;
/**
* Initializes a new instance of the ASPxClientRichEditPointerUpEventArgs object. For internal use only.
* @param htmlEvent A DHTML event object that relates to the processed event.
* @param handled true if the event is handled and no default processing is required; otherwise false.
*/
constructor(htmlEvent: any, handled: any);
}
/**
* Represents an individual item of the Rich Edit's context menu.
*/
declare class ASPxClientRichEditPopupMenuItem {
/**
* Gets the immediate parent menu item to which the current menu item belongs.
*/
parent: ASPxClientRichEditPopupMenuItem;
/**
* Gets or sets the unique identifier name for the current menu item.
*/
name: string;
/**
* Gets or sets the text content of the current 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.
*/
enabled: boolean;
/**
* Gets or sets the CSS class name defining the menu item's image.
*/
imageClassName: string;
/**
* Gets or sets a URL which defines the navigation location.
*/
navigateUrl: string;
/**
* Gets or sets the URL of the menu item's image.
*/
imageUrl: string;
/**
* Gets or sets a value that specifies whether the current menu item starts a group.
*/
beginGroup: boolean;
/**
* Gets or sets the current menu item's tooltip text.
*/
tooltip: string;
/**
* Gets or sets the window or frame at which to target the contents of the URL associated with the current menu item.
*/
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. An ASPxClientRichEditPopupMenuItem object representing the found sub-item.
* @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 ASPxClientRichEditPopupMenuItem.name property value. An ASPxClientRichEditPopupMenuItem object representing the found sub-item.
* @param name A string value specifying the ASPxClientRichEditPopupMenuItem.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.
*/
declare class 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 ASPxClientRichEditPopupMenuItem.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 ASPxClientRichEditPopupMenuItem.name property value. An ASPxClientRichEditPopupMenuItem object with a specific value of the ASPxClientRichEditPopupMenuItem.name property.
* @param name A string value representing the ASPxClientRichEditPopupMenuItem.name property value of the required item.
*/
GetByName(name: string): ASPxClientRichEditPopupMenuItem;
/**
* Returns a menu item specified by its index in the collection. An ASPxClientRichEditPopupMenuItem object that is a menu item with the specified index.
* @param index An integer value that is the zero-based index of the ASPxClientRichEditPopupMenuItem to retrieve from the ASPxClientRichEditPopupMenuItemCollection.
*/
Get(index: number): ASPxClientRichEditPopupMenuItem;
/**
* Removes all menu items from the collection.
*/
Clear(): void;
}
/**
* Provides data for the ASPxClientRichEdit.PopupMenuShowing event.
*/
declare class ASPxClientRichEditPopupMenuShowingEventArgs extends ASPxClientCancelEventArgs {
/**
* Provides access to a collection of menu items in the context menu being invoked.
*/
menuItems: ASPxClientRichEditPopupMenuItemCollection;
/**
* Initializes a new instance of the ASPxClientRichEditPopupMenuShowingEventArgs object. For internal use only.
* @param menuItems Provides access to the context menu's item collection.
*/
constructor(menuItems: ASPxClientRichEditPopupMenuItemCollection);
}
/**
* A method that handles the ContentRemoved event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditContentRemovedEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditContentRemovedEventArgs): any;
}
/**
* A method that handles the AutoCorrect event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditAutoCorrectEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditAutoCorrectEventArgs): any;
}
/**
* A method that handles the ParagraphPropertiesChanged event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditParagraphPropertiesChangedEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditParagraphPropertiesChangedEventArgs): any;
}
/**
* A method that handles the CharacterPropertiesChanged event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditCharacterPropertiesChangedEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditCharacterPropertiesChangedEventArgs): any;
}
/**
* A method that handles the ContentInserted event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditContentInsertedEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditContentInsertedEventArgs): any;
}
/**
* A method that handles the HyperlinkClick event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditHyperlinkClickEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditHyperlinkClickEventArgs): any;
}
/**
* A method that handles the PopupMenuShowing event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditPopupMenuShowingEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditPopupMenuShowingEventArgs): any;
}
/**
* A method that handles the KeyUp event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditKeyUpEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditKeyUpEventArgs): any;
}
/**
* A method that handles the KeyDown event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditKeyDownEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditKeyDownEventArgs): any;
}
/**
* A method that handles the PointerUp event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditPointerUpEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditPointerUpEventArgs): any;
}
/**
* A method that handles the PointerDown event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditPointerDownEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditPointerDownEventArgs): any;
}
/**
* A method that handles the CustomCommandExecuted event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditCustomCommandExecutedEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditCustomCommandExecutedEventArgs): any;
}
/**
* A method that handles the DocumentFormatted event.
* @param source The event source.
* @param e An object that contains event data.
*/
interface ASPxClientRichEditDocumentFormattedEventHandler {
(source: ASPxClientRichEdit, e: ASPxClientRichEditDocumentFormattedEventArgs): any;
}
/**
* Contains members related to the document's layout functionality.
*/
declare class RichEditLayout {
/**
* Returns bounds of the specified document model's position. The object that contains position bounds.
* @param position The position in a document model.
* @param endOfLine true to return bounds of a position at the end of a line; false to return bounds of a position at a new line start.
*/
getPositionBounds(position: number, endOfLine?: boolean): Rectangle;
}
/**
* Contains the size and coordinates of a rectangle.
*/
declare class Rectangle {
/**
* Gets the x-coordinate of the upper-left corner of the rectangle.
*/
x: number;
/**
* Gets the y-coordinate of the upper-left corner of the rectangle.
*/
y: number;
/**
* Gets the rectangle's width.
*/
width: number;
/**
* Gets the rectangle's height.
*/
height: number;
}
/**
* Defines custom loading panel members.
*/
interface ICustomLoadingPanel {
/**
* Specifies whether the panel is visible.
*/
visible?: boolean;
/**
* Shows the loading panel.
*/
show(): void;
/**
* Hides the loading panel.
*/
hide(): void;
}
/**
* Contains settings related to the loading panel functionality.
*/
declare class LoadingPanel {
/**
* Specifies whether the loading panel is enabled in the control.
*/
enabled: boolean;
/**
* Allows you to provide a custom loading panel.
*/
customPanel: undefined | ICustomLoadingPanel;
/**
* Shows the loading panel.
*/
show(): void;
/**
* Hides the loading panel.
*/
hide(): void;
}
/**
* Contains control requests' settings.
*/
declare class RequestSettings {
/**
* Specifies the maximum number of commands that can be sent in one request.
*/
maxCommandCount: number;
/**
* Specifies the time that the control waits for a response before to sent a request again.
*/
responseWaitingTime: number;
/**
* Specifies a period before a request is sent to the server.
*/
pendingPeriod: number;
}
/**
* Contains the method to convert different units of measurement.
*/
declare class RichEditUnitConverter {
/**
* Converts a measurement from pixels to twips. The result twips value.
* @param value The pixels value to be converted.
*/
pixelsToTwips(value: number): number;
/**
* Converts a measurement from inches to twips. The result twips value, as an integer.
* @param value The inches value (floating) to be converted.
*/
inchesToTwips(value: number): number;
/**
* Converts a measurement from points to twips. The result twips value.
* @param value The points value to be converted.
*/
pointsToTwips(value: number): number;
/**
* Converts a value in centimeters to twips. An integer value representing the value in twips.
* @param value A floating value specifying the value in centimeters to convert.
*/
centimetersToTwips(value: number): number;
/**
* Converts a measurement from twips to centimeters. The result centimeters value.
* @param value The twips value to be converted.
*/
twipsToCentimeters(value: number): number;
/**
* Converts a measurement from pixels to centimeters. The result centimeters value.
* @param value The pixels value to be converted.
*/
pixelsToCentimeters(value: number): number;
/**
* Converts a measurement from twips to inches. The result inches value.
* @param value The twips value to be converted.
*/
twipsToInches(value: number): number;
/**
* Converts a measurement from pixels to inches. The result inches value.
* @param value The pixels value to be converted.
*/
pixelsToInches(value: number): number;
/**
* Converts a measurement from pixels to points. The result points value.
* @param value The pixels value to be converted.
*/
pixelsToPoints(value: number): number;
/**
* Converts a measurement from twips to points. The result points value.
* @param value The twips value to be converted.
*/
twipsToPoints(value: number): number;
}
/**
* A client-side equivalent of the ASPxRichEdit object.
*/
declare class ASPxClientRichEdit extends ASPxClientControl {
/**
* Occurs after a custom command has been executed on the client side.
*/
CustomCommandExecuted: ASPxClientEvent;
/**
* Fires after a client change has been made to the document and the client-server synchronization starts to apply the change on the server.
*/
BeginSynchronization: ASPxClientEvent>;
/**
* Fires after a document change has been applied to the server and server and client document models have been synchronized.
*/
EndSynchronization: ASPxClientEvent>;
/**
* Occurs when a callback for server-side processing is initiated.
*/
BeginCallback: ASPxClientEvent>;
/**
* Occurs on the client side after a callback's server-side processing has been completed.
*/
EndCallback: ASPxClientEvent>;
/**
* 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>;
/**
* Occurs on the client side when a document layout is formatted.
*/
DocumentFormatted: ASPxClientEvent;
/**
* Fires if any change is made to the RichEdit's document on the client.
*/
DocumentChanged: ASPxClientEvent>;
/**
* 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;
/**
* Fires when text is typed in the control.
*/
AutoCorrect: ASPxClientEvent;
/**
* Provides access to document structural elements.
*/
document: RichEditDocument;
/**
* Provides access to the RichEdit's client-side commands.
*/
commands: RichEditCommands;
/**
* Provides access to the client methods that change the selection.
*/
selection: RichEditSelection;
/**
* Provides access to a document's layout functionality.
*/
layout: RichEditLayout;
/**
* Gets a unit converter.
*/
unitConverter: RichEditUnitConverter;
/**
* Provides access to request settings.
*/
requestSettings: RequestSettings;
/**
* Provides access to settings related to a loading panel functionality.
*/
loadingPanel: LoadingPanel;
/**
* 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.
*/
SetFullscreenMode(fullscreen: boolean): void;
/**
* Provides access to an object implementing the RichEdit's ribbon UI.
*/
GetRibbon(): ASPxClientRibbon;
/**
* Sets input focus to the RichEdit.
*/
Focus(): void;
/**
* Sends a callback to the server and generates the server-side ASPxRichEdit.Callback event, passing it the specified argument.
* @param parameter A string value that represents any information that needs to be sent to the server-side event.
* @param onSuccess A client action to perform if the server round-trip completed successfully.
*/
PerformCallback(parameter: string, onSuccess?: (arg: string) => void): void;
/**
* Indicates whether any unsaved changes are contained in the current document.
*/
HasUnsavedChanges(): boolean;
/**
* Reconnects the RichEdit to an external ribbon.
*/
ReconnectToExternalRibbon(): void;
/**
* Converts the specified object to the ASPxClientRichEdit type. The converted client object specified by the obj parameter.
* @param obj The client object to be type cast.
*/
static Cast(obj: any): ASPxClientRichEdit;
}
/**
* Holds the information that determines what action types can be performed for appointments.
*/
declare class ASPxClientAppointmentFlags {
/**
* Gets a value that specifies whether an end-user is allowed to delete appointments.
*/
allowDelete: boolean;
/**
* Gets a value that specifies whether an end-user is allowed to edit appointments.
*/
allowEdit: boolean;
/**
* Gets a value that specifies whether an end-user is allowed to change the time boundaries of appointments.
*/
allowResize: boolean;
/**
* Gets a value that specifies whether an end-user is allowed to copy appointments.
*/
allowCopy: boolean;
/**
* Gets a value that specifies whether an end-user is allowed to drag and drop appointments to another time slot or date.
*/
allowDrag: boolean;
/**
* Gets a value that specifies whether an end-user is allowed to drag and drop appointments between resources.
*/
allowDragBetweenResources: boolean;
/**
* Gets a value that specifies whether an inplace editor can be activated for an appointment.
*/
allowInplaceEditor: boolean;
/**
* Gets a value that specifies whether an end-user is allowed to share the schedule time between two or more appointments.
*/
allowConflicts: boolean;
}
/**
* Represents a client-side equivalent of the Appointment class.
*/
declare class ASPxClientAppointment {
/**
* Returns the client appointment ID.
*/
appointmentId: string;
/**
* Gets or sets the time interval of the time cells covered by the current appointment.
*/
interval: ASPxClientTimeInterval;
/**
* Gets resources associated with the appointment.
*/
resources: string[];
/**
* Gets the appointment type.
*/
appointmentType: ASPxAppointmentType;
/**
* Gets the status index.
*/
statusIndex: number;
/**
* Returns the label's index.
*/
labelIndex: number;
/**
* Adds a resource to the collection of resources associated with the client appointment.
* @param resourceId An object, representing the resource id.
*/
AddResource(resourceId: string): void;
/**
* Gets the resource associated with the client-side appointment by its index. An identifier of the specified resource (IPersistentObject.Id)
* @param index An integer, representing an index of a resource in a resource collection associated with the current appointment.
*/
GetResource(index: number): string;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.Start appointment property.
* @param start A JavaScript Date object representing the appointment start.
*/
SetStart(start: Date): void;
/**
* Gets the start date and time of the appointment.
*/
GetStart(): Date;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.End appointment property.
* @param end A JavaScript Date object representing the end of the appointment.
*/
SetEnd(end: Date): void;
/**
* Gets the end date and time of the appointment.
*/
GetEnd(): Date;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.Duration appointment property.
* @param duration A TimeSpan object representing the appointment duration.
*/
SetDuration(duration: any): void;
/**
* Returns the duration of the appointment.
*/
GetDuration(): number;
/**
* Sets the ID of the client appointment.
* @param id An string value representing the appointment identifier.
*/
SetId(id: string): void;
/**
* Gets the ID of the client appointment.
*/
GetId(): string;
/**
* Specifies the type of the current client appointment.
* @param type An ASPxAppointmentType enumeration value indicating the appointment type.
*/
SetAppointmentType(type: ASPxAppointmentType): void;
/**
* Returns the appointment type.
*/
GetAppointmentType(): ASPxAppointmentType;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.StatusId appointment property.
* @param statusId An integer representing the index in the AppointmentStatusCollection.
*/
SetStatusId(statusId: number): void;
/**
* Gets or sets the integer identifier of the status object associated with the appointment.
*/
GetStatusId(): number;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.LabelId appointment property.
* @param statusId An integer representing the index of the label in the AppointmentStorage.Labels label collection.
*/
SetLabelId(statusId: number): void;
/**
* Gets or sets the integer identifier of the label object associated with the appointment.
*/
GetLabelId(): number;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.Subject appointment property.
* @param subject A string containing the appointment subject.
*/
SetSubject(subject: string): void;
/**
* Gets or sets the appointment's subject text.
*/
GetSubject(): string;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.Description appointment property.
* @param description A string representing the appointment description.
*/
SetDescription(description: string): void;
/**
* Gets the description of the appointment.
*/
GetDescription(): string;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.Location appointment property.
* @param location A string representing the appointment location.
*/
SetLocation(location: string): void;
/**
* Gets or sets the text that specifies a place where the appointment is scheduled.
*/
GetLocation(): string;
/**
* Specifies the property value of the client appointment corresponding to the Appointment.AllDay appointment property.
* @param allDay true to indicate the all-day appointment; otherwise, false.
*/
SetAllDay(allDay: boolean): void;
/**
* Returns a value specifying whether the current appointment lasts the entire day.
*/
GetAllDay(): boolean;
/**
* Gets the appointment that is the Appointment.RecurrencePattern for the current appointment.
*/
GetRecurrencePattern(): ASPxClientAppointment;
/**
* Sets the property value of the client appointment, corresponding to the Appointment.RecurrenceInfo appointment property.
* @param recurrenceInfo An ASPxClientRecurrenceInfo object representing the recurrence information.
*/
SetRecurrenceInfo(recurrenceInfo: ASPxClientRecurrenceInfo): void;
/**
* Gets the property value of the client appointment corresponding to the Appointment.RecurrenceInfo appointment property.
*/
GetRecurrenceInfo(): ASPxClientRecurrenceInfo;
}
/**
* Contains information defining the occurrences of a recurring client appointment.
*/
declare class ASPxClientRecurrenceInfo {
/**
* Initializes a new instance of the ASPxClientRecurrenceInfo class with default settings.
*/
constructor();
/**
* Sets the recurrence start date.
* @param start A JavaScript date object value that specifies the start date for the recurrence.
*/
SetStart(start: Date): void;
/**
* Gets the recurrence start date.
*/
GetStart(): Date;
/**
* Sets the recurrence end date.
* @param end A JavaScript Date object that specifies the end date for the recurrence.
*/
SetEnd(end: Date): void;
/**
* Gets the recurrence end date.
*/
GetEnd(): Date;
/**
* Sets the duration of the recurrence.
* @param duration A TimeSpan object representing the duration.
*/
SetDuration(duration: any): void;
/**
* Gets the duration of the recurrence.
*/
GetDuration(): number;
/**
* Sets the time base for the frequency of the corresponding appointment occurrences.
* @param type An ASPxClientRecurrenceType enumeration value that specifies the recurrence's frequency type.
*/
SetRecurrenceType(type: ASPxClientRecurrenceType): void;
/**
* Gets the time base for the frequency of the corresponding appointment reoccurrence.
*/
GetRecurrenceType(): ASPxClientRecurrenceType;
/**
* Sets the day/days in a week that the corresponding appointment recurs on.
* @param weekDays The ASPxClientWeekDays enumeration value specifying the day/days in a week.
*/
SetWeekDays(weekDays: ASPxClientWeekDays): void;
/**
* Gets the day/days in a week on which the corresponding appointment occurs.
*/
GetWeekDays(): ASPxClientWeekDays;
/**
* Sets how many times the appointment occurs.
* @param occurrenceCount An integer value that specifies how many times the appointment occurs.
*/
SetOccurrenceCount(occurrenceCount: number): void;
/**
* Gets how many times the appointment occurs.
*/
GetOccurrenceCount(): number;
/**
* Sets the frequency with which the corresponding appointment occurs (dependent on the recurrence Type).
* @param periodicity An integer value that specifies the frequency with which the corresponding appointment occurs.
*/
SetPeriodicity(periodicity: number): void;
/**
* Gets the frequency with which the corresponding appointment reoccurs (dependent on the recurrence Type).
*/
GetPeriodicity(): number;
/**
* Sets the ordinal number of a day within a defined month.
* @param dayNumber A positive integer value that specifies the day number within a month.
*/
SetDayNumber(dayNumber: number): void;
/**
* Gets the ordinal number of a day within a defined month.
*/
GetDayNumber(): number;
/**
* Sets the occurrence number of the week in a month for the recurrence pattern.
* @param weekOfMonth A ASPxClientWeekOfMonth enumeration value that specifies a particular week in every month.
*/
SetWeekOfMonth(weekOfMonth: ASPxClientWeekOfMonth): void;
/**
* Gets the occurrence number of the week in a month for the recurrence pattern.
*/
GetWeekOfMonth(): ASPxClientWeekOfMonth;
/**
* Sets the month (as a number) on which the corresponding appointment occurs.
* @param month A positive integer value that specifies the month's number.
*/
SetMonth(month: number): void;
/**
* Gets the month (as a number) on which the corresponding appointment recurs.
*/
GetMonth(): number;
/**
* Gets the type of the recurrence range.
*/
GetRange(): ASPxClientRecurrenceRange;
/**
* Sets the type of the recurrence range.
* @param range An ASPxClientRecurrenceRangeenumeration value that specifies the recurrence range type.
*/
SetRange(range: ASPxClientRecurrenceRange): void;
}
/**
* Represents a client-side equivalent of the AppointmentType enumeration.
*/
declare class ASPxAppointmentType {
/**
* Gets a string representation equivalent of ASPxAppointmentType.Normal enumeration for use in client scripts.
*/
Normal: string;
/**
* Gets a string representation equivalent of ASPxAppointmentType.Pattern enumeration for use in client scripts.
*/
Pattern: string;
/**
* Gets a string representation equivalent of ASPxAppointmentType.Occurrence enumeration for use in client scripts.
*/
Occurrence: string;
/**
* Gets a string representation equivalent of AppointmentType.ChangedOccurrence enumeration for use in client scripts.
*/
ChangedOccurrence: string;
/**
* Gets a string representation equivalent of ASPxAppointmentType.DeletedOccurrence enumeration for use in client scripts.
*/
DeletedOccurrence: string;
}
/**
* Contains types of the recurrence range.
*/
declare class ASPxClientRecurrenceRange {
/**
* A recurring appointment will not have an end date, i.e. infinite recurrence
*/
NoEndDate: string;
/**
* A recurring appointment will end after its recurrence count exceeds the value specified by the ASPxClientRecurrenceInfo.SetOccurrenceCount method.
*/
OccurrenceCount: string;
/**
* A recurring appointment will end after the date specified by the ASPxClientRecurrenceInfo.SetEnd method.
*/
EndByDate: string;
}
/**
* Contains recurrence types.
*/
declare class ASPxClientRecurrenceType {
/**
* The recurring appointment occurs on a daily basis.
*/
Daily: string;
/**
* The recurring appointment reoccurs on a weekly basis.
*/
Weekly: string;
/**
* The recurring appointment reoccurs on a monthly basis.
*/
Monthly: string;
/**
* The recurring appointment reoccurs on an yearly basis.
*/
Yearly: string;
/**
* The recurring appointment occurs on an hourly base.
*/
Hourly: string;
}
/**
* Contains number of weeks in a month in which the event occurs.
*/
declare class ASPxClientWeekOfMonth {
/**
* There isn't any recurrence rule based on the weeks in a month.
*/
None: number;
/**
* The recurring event will occur once a month, on the specified day or days of the first week in the month.
*/
First: number;
/**
* The recurring event will occur once a month, on the specified day or days of the second week in the month.
*/
Second: number;
/**
* The recurring event will occur once a month, on the specified day or days of the third week in the month.
*/
Third: number;
/**
* The recurring event will occur once a month, on the specified day or days of the fourth week in the month.
*/
Fourth: number;
/**
* The recurring event will occur once a month, on the specified day or days of the last week in the month.
*/
Last: number;
}
/**
* Contains days and groups of days for use in recurrence patterns.
*/
declare class ASPxClientWeekDays {
/**
* Specifies Sunday.
*/
Sunday: number;
/**
* Specifies Monday.
*/
Monday: number;
/**
* Specifies Tuesday.
*/
Tuesday: number;
/**
* Specifies Wednesday.
*/
Wednesday: number;
/**
* Specifies Thursday.
*/
Thursday: number;
/**
* Specifies Friday.
*/
Friday: number;
/**
* Specifies Saturday.
*/
Saturday: number;
/**
* Specifies Saturday and Sunday.
*/
WeekendDays: number;
/**
* Specifies work days (Monday, Tuesday, Wednesday, Thursday and Friday).
*/
WorkDays: number;
/**
* Specifies every day of the week.
*/
EveryDay: number;
}
/**
* Contains information related to the reminder alert.
*/
declare class ASPxClientReminderAlertNotification {
/**
* Returns the triggered reminder.
*/
reminder: ASPxClientReminder;
/**
* Gets the appointment associated with the triggered reminder.
*/
appointment: ASPxClientAppointment;
/**
* Gets or sets whether the reminder is handled and therefore no default processing is required.
*/
handled: boolean;
/**
* Gets or sets whether an alert is invoked for a particular reminder.
*/
ignore: boolean;
/**
* Gets the triggered reminder's ID.
*/
GetReminderId(): string;
/**
* Gets the triggered reminder.
*/
GetReminder(): ASPxClientReminder;
/**
* Gets the appointment associated with the reminder.
*/
GetAppointment(): ASPxClientAppointment;
}
/**
* Represents a client-side equivalent of the Reminder class.
*/
declare class ASPxClientReminder {
/**
* Gets the reminder's ID.
*/
GetId(): string;
/**
* Returns the date and time when the reminder is alerted.
*/
GetAlertTime(): Date;
/**
* Gets the time interval before the appointment's start time.
*/
GetTimeBeforeStart(): Date;
/**
* Gets the custom field bound to the reminder. An object representing the custom field.
* @param key A string object representing the custom field's ID.
*/
GetCustomField(key: string): any;
/**
* Switches the reminder off for the associated appointment.
*/
Dismiss(): void;
/**
* Delays the reminder's alert until the alert time has increased by the specified interval.
* @param remindAfter An integer value that is the time interval.
*/
Snooze(remindAfter: number): void;
}
/**
* A method that will handle the ASPxClientSchedulerStorageControl.ReminderAlert event.
* @param source The event source.
* @param e An ASPxClientSchedulerStorageControl object that contains event data.
*/
interface ReminderAlertEventHandler { (source: Sender, e: ASPxClientSchedulerStorageReminderAlertEventArgs): void; }
/**
* Provides data for the ASPxClientSchedulerStorageControl.ReminderAlert event.
*/
declare class ASPxClientSchedulerStorageReminderAlertEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSchedulerStorageReminderAlertEventArgs class.
* @param completedNotifications An array of ASPxClientReminderAlertNotification objects.
* @param previousNotifications An array of ASPxClientReminderAlertNotification objects.
*/
constructor(completedNotifications: ASPxClientReminderAlertNotification[], previousNotifications: ASPxClientReminderAlertNotification[]);
/**
* Returns an array of currently triggered reminders.
*/
alertNotifications: ASPxClientReminderAlertNotification[];
}
/**
* Represents a client-side equivalent of the Resource class.
*/
declare class ASPxClientResource {
/**
* Gets the resource ID.
*/
resourceId: string;
/**
* Returns the resource's caption.
*/
caption: string;
/**
* Gets the resource's color.
*/
color: string;
/**
* Gets the ID of the client appointment.
*/
GetId(): string;
/**
* Returns the resource's caption.
*/
GetCaption(): string;
/**
* Gets the resource's color.
*/
GetColor(): string;
}
/**
* Holds action types for the client-side ASPxClientScheduler.Refresh method.
*/
declare class ASPxClientSchedulerRefreshAction {
/**
* Gets the value of the action parameter which initiates a simple reload of the control.
*/
None: number;
/**
* Gets the value of the action parameter which initiates reloading of the main ASPxScheduler control and its data-dependent satellites.
*/
VisibleIntervalChanged: number;
/**
* Gets the value of the action parameter which initiates reloading of the main ASPxScheduler control and its satellite View controls.
*/
ActiveViewTypeChanged: number;
}
/**
* Contains methods allowing you to perform or cancel an operation.
*/
declare class ASPxClientAppointmentOperation {
/**
* Passes parameters to the corresponding callback function to accomplish the operation.
*/
Apply(): void;
/**
* Cancels the operation.
*/
Cancel(): void;
}
/**
* Represents the client-side equivalent of the ASPxScheduler control.
*/
declare class ASPxClientScheduler extends ASPxClientControl {
/**
* Converts the specified object to the ASPxClientScheduler type. The converted client object specified by the obj parameter.
* @param obj The client object to be type cast.
*/
static Cast(obj: any): ASPxClientScheduler;
/**
* Sets whether the resources with specified IDs are visible.
* @param resourceIds An array of string values specifying the resources IDs.
*/
SetVisibleResources(resourceIds: string[]): void;
/**
* Client-side scripting method that gets the active View.
*/
GetActiveViewType(): ASPxSchedulerViewType;
/**
* Client-side scripting method to change the ASPxScheduler's active View.
* @param value A ASPxSchedulerViewType enumeration value, representing a view type to set.
*/
SetActiveViewType(value: ASPxSchedulerViewType): void;
/**
* Occurs when a callback for server-side processing is initiated.
*/
BeginCallback: ASPxClientEvent>;
/**
* Occurs on the client side after a callback's server-side processing has been completed.
*/
EndCallback: ASPxClientEvent>;
/**
* Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientScheduler.
*/
CallbackError: ASPxClientEvent>;
/**
* Sends a callback to the server and generates the server-side ASPxSchedulerDataWebControlBase.CustomCallback event, passing it the specified argument
* @param parameter A string value that represents any information that needs to be sent to the server-side ASPxSchedulerDataWebControlBase.CustomCallback event.
*/
PerformCallback(parameter: string): void;
/**
* Client-side scripting method which initiates a round trip to the server, so that the control will be reloaded using the specified refresh action.
* @param refreshAction An ASPxClientSchedulerRefreshAction enumeration value, specifying the refresh action.
*/
Refresh(refreshAction?: ASPxClientSchedulerRefreshAction): void;
/**
* Client-side function that returns the type of grouping applied to the appointments displayed in the scheduler.
*/
GetGroupType(): ASPxSchedulerGroupType;
/**
* Client-side scripting method which raises the callback command to set the ASPxScheduler.GroupType.
* @param value An ASPxSchedulerGroupType enumeration value, which specifies how appointments are grouped.
*/
SetGroupType(value: ASPxSchedulerGroupType): void;
/**
* Client-side method that navigates the scheduler to the current system date.
*/
GotoToday(): void;
/**
* Client-side scripting method which raises the SchedulerCallbackCommandId.GotoDate callback command.
* @param date A DateTime value specifying the destination time.
*/
GotoDate(date: Date): void;
/**
* Client-side function which slides the visible interval one time span back.
*/
NavigateBackward(): void;
/**
* Client-side function which slides the visible interval one time span forward.
*/
NavigateForward(): void;
/**
* Client-side method which raises the callback command to change the SchedulerOptionsBehaviorBase.ClientTimeZoneId of the scheduler.
* @param timeZoneId A string, a time zone identifier which is valid for the System.TimeZoneInfo.Id property.
*/
ChangeTimeZoneId(timeZoneId: string): void;
/**
* Displays a Selection ToolTip on a position given by the specified coordinates.
* @param x An integer representing the X-coordinate.
* @param y An integer representing the Y-coordinate.
*/
ShowSelectionToolTip(x: number, y: number): void;
/**
* 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 Specifies the time interval to select.
* @param resourceId Specifies the resource ID to which the specified time interval belongs.
* @param scrollToSelection true, to scroll the scheduler content 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.
*/
GetSelectedResource(): string;
/**
* Gets a collection of visible appointments.
*/
GetVisibleAppointments(): ASPxClientAppointment[];
/**
* Client-side function that returns an appointment with the specified ID. An ASPxClientAppointment object, representing an appointment on the client.
* @param id An appointment's identifier.
*/
GetAppointmentById(id: string): ASPxClientAppointment;
/**
* Client-side function that returns the id's of selected appointments.
*/
GetSelectedAppointmentIds(): string[];
/**
* Client-side function that removes the appointment specified by its client ID from a collection of selected appointments.
* @param aptId An appointment's identifier.
*/
DeselectAppointmentById(aptId: string): void;
/**
* Selects the appointment with the specified ID.
* @param aptId A string value specifying the appointment ID.
* @param scrollToSelection true, to scroll to the selected appointment; otherwise, false.
*/
SelectAppointmentById(aptId: string, scrollToSelection?: boolean): void;
/**
* Enables obtaining appointment property values in a client-side script. Executes the callback command with the SchedulerCallbackCommandId.AppointmentData identifier. An array of strings containing string representations of appointment properties.
* @param aptId A string, representing the appointment ID.
* @param propertyNames An array of strings, representing the appointment properties to query.
* @param onCallBack A handler of a function which will receive and process the property values.
*/
GetAppointmentProperties(aptId: string, propertyNames: string[], onCallBack: any): string[];
/**
* Initiates a callback to retrieve and apply the values for the specified list of properties to the specified appointment, and transfer control to the specified function.
* @param clientAppointment An ASPxClientAppointment object that is the client appointment for which the data is retrieved.
* @param propertyNames An array of strings, that are the names of appointment properties to query.
* @param onCallBack A handler of a function executed after a callback.
*/
RefreshClientAppointmentProperties(clientAppointment: ASPxClientAppointment, propertyNames: string[], onCallBack: any): void;
/**
* Client-side function that invokes the editing form for the appointment specified by its client ID.
* @param aptClientId A string, representing the appointment client identifier.
*/
ShowAppointmentFormByClientId(aptClientId: string): void;
/**
* Client-side function that invokes the editing form for the appointment specified by its storage identifier.
* @param aptServerId A string, representing the appointment identifier.
*/
ShowAppointmentFormByServerId(aptServerId: string): void;
/**
* Sets the time of the day corresponding to the start of the topmost displayed time cell row.
* @param duration An integer, representing the number of milliseconds passed since the start of the day.
* @param viewType An ASPxSchedulerViewType enumeration member, representing the scheduler's View. It can be either 'Day' or 'WorkWeek'.
*/
SetTopRowTime(duration: number, viewType?: ASPxSchedulerViewType): void;
/**
* Gets the time of the day corresponding to the start of the topmost displayed time cell row. An integer, representing the number of milliseconds passed since the start of the day.
* @param viewType An ASPxSchedulerViewType enumeration member, representing the scheduler's View. It can be either "Day" or "WorkWeek", otherwise the result is undefined.
*/
GetTopRowTime(viewType?: ASPxSchedulerViewType): number;
/**
* Client-side scripting method which displays the Loading Panel.
*/
ShowLoadingPanel(): void;
/**
* Client-side scripting method which hides the Loading Panel from view.
*/
HideLoadingPanel(): void;
/**
* Client-side method that invokes the inplace editor form to create a new appointment.
* @param start A date object, representing the start of the new appointment.
* @param end A date object, representing the end of the new appointment.
* @param resourceId An object representing the identifier of a resource associated with the new appointment.
*/
ShowInplaceEditor(start: Date, end: Date, resourceId?: string): void;
/**
* Client-side scripting method to insert the specified appointment.
* @param apt An ASPxClientAppointment object representing the client-side appointment.
*/
InsertAppointment(apt: ASPxClientAppointment): void;
/**
* Client-side scripting method to update the specified appointment.
* @param apt An ASPxClientAppointment object representing the client-side appointment.
*/
UpdateAppointment(apt: ASPxClientAppointment): void;
/**
* Client-side scripting method to delete the specified appointment.
* @param apt An ASPxClientAppointment object representing the client-side appointment.
*/
DeleteAppointment(apt: ASPxClientAppointment): void;
/**
* Client-side method that allows retrieving a collection of time intervals displayed by the ASPxScheduler.
*/
GetVisibleIntervals(): ASPxClientTimeInterval[];
/**
* Changes the container that the ASPxScheduler tooltip belongs to.
* @param container An object that serves as the new container for the pop-up menu.
*/
ChangeToolTipContainer(container: any): void;
/**
* Changes the container that the ASPxScheduler pop-up menu belongs to.
* @param container An object that serves as the new container for the pop-up menu.
*/
ChangePopupMenuContainer(container: any): void;
/**
* Returns focus to the form if the ASPxScheduler control is not visible when the reminder fires.
* @param container A DIV object that is located in such a way that it is visible on the page in situations when the ASPxScheduler control is hidden.
*/
ChangeFormContainer(container: any): void;
/**
* Client-side scripting method that saves appointment modifications and closes the form.
*/
AppointmentFormSave(): void;
/**
* Client-side scripting method that deletes the appointment being edited.
*/
AppointmentFormDelete(): void;
/**
* Client-side scripting method that cancels changes and closes the appointment editing form.
*/
AppointmentFormCancel(): void;
/**
* Client-side scripting method that navigates the scheduler to the date selected in the GotoDate form and closes the form.
*/
GoToDateFormApply(): void;
/**
* Client-side scripting method that cancels changes and closes the GotoDate form.
*/
GoToDateFormCancel(): void;
/**
* Client-side scripting method that cancels changes and closes the form.
*/
InplaceEditFormSave(): void;
/**
* Client-side scripting method that cancels changes and closes the form.
*/
InplaceEditFormCancel(): void;
/**
* Client-side scripting method that invokes the appointment editing form for the appointment being edited in the inplace editor.
*/
InplaceEditFormShowMore(): void;
/**
* Client-side scripting method that closes the Reminder form.
*/
ReminderFormCancel(): void;
/**
* Client-side scripting method that calls the ReminderBase.Dismiss method for the selected reminder.
*/
ReminderFormDismiss(): void;
/**
* Client-side scripting method that dismisses all reminders shown in the Reminder form.
*/
ReminderFormDismissAll(): void;
/**
* 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;
/**
* Returns the floating action button's object.
*/
GetFloatingActionButton(): ASPxClientFloatingActionButton;
/**
* Occurs on the client side when the Scheduler control is about to change its active view.
*/
ActiveViewChanging: ASPxClientEvent>;
/**
* Client-side event. Occurs after the active view of the ASPxScheduler has been changed.
*/
ActiveViewChanged: ASPxClientEvent>;
/**
* Occurs when an end-user presses a keyboard shortcut.
*/
Shortcut: ASPxClientEvent>;
/**
* Occurs when the end-user clicks an appointment.
*/
AppointmentClick: ASPxClientEvent>;
/**
* Occurs when the end-user double clicks on an appointment.
*/
AppointmentDoubleClick: ASPxClientEvent>;
/**
* Occurs when an end-user clicks a time cell.
*/
CellClick: ASPxClientEvent>;
/**
* Occurs when and end-user double-clicks a time cell.
*/
CellDoubleClick: ASPxClientEvent>;
/**
* Occurs on the client side when the user selects an appointment.
*/
AppointmentsSelectionChanged: ASPxClientEvent>;
/**
* Fires on the client side when the time cell selection is changed.
*/
SelectionChanged: ASPxClientEvent>;
/**
* Occurs on the client side when the time cell selection is about to change.
*/
SelectionChanging: ASPxClientEvent>;
/**
* Fires on the client side when the time interval of the scheduling area is changed.
*/
VisibleIntervalChanged: ASPxClientEvent>;
/**
* Occurs when one of More Buttons is clicked.
*/
MoreButtonClicked: ASPxClientEvent>;
/**
* Client-side event that occurs when a popup menu item is clicked.
*/
MenuItemClicked: ASPxClientEvent>;
/**
* Client-side event that occurs after an appointment has been dragged and dropped.
*/
AppointmentDrop: ASPxClientEvent>;
/**
* A client-side event that occurs when an appointment is being dragged.
*/
AppointmentDrag: ASPxClientEvent>;
/**
* A client-side event that occurs when an appointment is being resized.
*/
AppointmentResizing: ASPxClientEvent>;
/**
* Client-side event that occurs when an appointment is resized.
*/
AppointmentResize: ASPxClientEvent>;
/**
* 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>;
}
/**
* Represents a client-side equivalent of the SchedulerViewType object.
*/
declare class ASPxSchedulerViewType {
/**
* Gets a string representation equivalent of SchedulerViewType.Day enumeration for use in client scripts.
*/
Day: string;
/**
* Gets a string representation equivalent of SchedulerViewType.WorkWeek enumeration for use in client scripts.
*/
WorkWeek: string;
/**
* Gets a string representation equivalent of SchedulerViewType.Week enumeration for use in client scripts.
*/
Week: string;
/**
* Gets a string representation equivalent of SchedulerViewType.Month enumeration for use in client scripts.
*/
Month: string;
/**
* Gets a string representation equivalent of SchedulerViewType.Timeline enumeration for use in client scripts.
*/
Timeline: string;
/**
* Gets a string representation equivalent of SchedulerViewType.FullWeek enumeration for use in client scripts.
*/
FullWeek: string;
/**
* Gets a string representation equivalent to the SchedulerViewType.Agenda enumeration for use in client scripts.
*/
Agenda: string;
}
/**
* Represents a client-side equivalent of the SchedulerGroupType enumeration.
*/
declare class ASPxSchedulerGroupType {
/**
* Gets a string representation equivalent of SchedulerGroupType.None enumeration for use in client scripts.
*/
None: string;
/**
* Gets a string representation equivalent of SchedulerGroupType.Date enumeration for use in client scripts.
*/
Date: string;
/**
* Gets a string representation equivalent of SchedulerGroupType.Resource enumeration for use in client scripts.
*/
Resource: string;
}
/**
* A method that will handle the ASPxClientScheduler.AppointmentDeleting event.
* @param source The event sender (typically an ASPxClientScheduler control).
* @param e A ASPxClientAppointmentDeletingEventArgs object that contains event data.
*/
interface ASPxClientAppointmentDeletingEventHandler { (source: Sender, e: ASPxClientAppointmentDeletingEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentDeleting event.
*/
declare class ASPxClientAppointmentDeletingEventArgs extends ASPxClientCancelEventArgs {
/**
* Creates an ASPxClientAppointmentDeletingEventArgs instance with the specified client appointments.
* @param appointments An array of ASPxClientAppointment objects.
*/
constructor(appointments: ASPxClientAppointment[]);
/**
* Gets client IDs of the appointments to be removed.
*/
appointmentIds: string[];
}
/**
* A method that will handle the ASPxClientScheduler.AppointmentClick event.
* @param source The event sender (typically an ASPxClientScheduler control).
* @param e A AppointmentClickEventArgs object that contains event data.
*/
interface AppointmentClickEventHandler { (source: Sender, e: AppointmentClickEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentClick and the ASPxClientScheduler.AppointmentDoubleClick events.
*/
declare class AppointmentClickEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the class.
* @param appointmentId Specifies an appointment ID.
* @param sourceEvent Specifies an event source.
*/
constructor(appointmentId: string, sourceEvent: any);
/**
* Gets the client appointment ID for the appointment being clicked.
*/
appointmentId: string;
/**
* Gets the HTML element that the event was triggered on.
*/
htmlElement: any;
/**
* Gets or sets whether an event is handled, and that default actions are not required.
*/
handled: boolean;
}
/**
* A method that will handle the ASPxClientScheduler.AppointmentsSelectionChanged event.
* @param source The ASPxScheduler control which fires the event.
* @param e A AppointmentsSelectionEventArgs object that contains event data.
*/
interface AppointmentsSelectionEventHandler { (source: Sender, e: AppointmentsSelectionEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentsSelectionChanged event.
*/
declare class AppointmentsSelectionEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the class.
* @param appointmentIds Represents an array of appointments' IDs.
*/
constructor(appointmentIds: string[]);
/**
* Gets identifiers of the selected appointments.
*/
appointmentIds: string[];
}
/**
* A method that will handle the ASPxClientScheduler.Shortcut event.
* @param source The event sender (typically an ASPxClientScheduler control).
* @param e A ShortcutEventArgs object that contains event data.
*/
interface ShortcutEventHandler { (source: Sender, e: ShortcutEventArgs): void; }
/**
* Provides data for the client-side ASPxClientScheduler.Shortcut event.
*/
declare class ShortcutEventArgs extends ASPxClientEventArgs {
/**
* Initialize a new instance of the class.
* @param commandName Specifies the command name.
* @param htmlEvent Specifies the html event.
*/
constructor(commandName: string, htmlEvent: any);
/**
* Gets the name of a command associated with the keyboard shortcut.
*/
commandName: string;
/**
* Gets an object containing information about a keyboard shortcut event.
*/
htmlEvent: any;
/**
* Gets or sets whether an event is handled, and that default actions are not required.
*/
handled: boolean;
}
/**
* A method that will handle the ASPxClientScheduler.ActiveViewChanging event.
* @param source The ASPxClientScheduler control which fires the event.
* @param e An ActiveViewChangingEventArgs object that contains event data
*/
interface ActiveViewChangingEventHandler { (source: Sender, e: ActiveViewChangingEventArgs): void; }
/**
* Provides data for the client-side ASPxClientScheduler.ActiveViewChanging event.
*/
declare class ActiveViewChangingEventArgs extends ASPxClientEventArgs {
/**
* Provides data for the client-side ActiveViewChanging event.
* @param oldView Represents the new View used by the Scheduler to show its data.
* @param newView Represents the previous View used by the Scheduler to show its data.
*/
constructor(oldView: ASPxSchedulerViewType, newView: ASPxSchedulerViewType);
/**
* Gets the value of the ASPxScheduler.ActiveView property before modification.
*/
oldView: ASPxSchedulerViewType;
/**
* Gets the new value of the ASPxScheduler.ActiveView property.
*/
newView: ASPxSchedulerViewType;
/**
* Gets or sets whether the change of active view should be canceled.
*/
cancel: boolean;
}
/**
* A method that will handle ASPxClientScheduler.MoreButtonClicked event.
* @param source The ASPxClientScheduler control which fires the event.
* @param e A MoreButtonClickedEventArgs object that contains event data.
*/
interface MoreButtonClickedEventHandler { (source: Sender, e: MoreButtonClickedEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.MoreButtonClicked client-side event.
*/
declare class MoreButtonClickedEventArgs extends ASPxClientProcessingModeEventArgs {
/**
* Initializes a new instance of MoreButtonClickedEventArgs class with the specified parameters.
* @param dateTime A DateTime value which corresponds to the top visible time of the target view.
* @param resource A Resource associated with the time cell where the "More" button is located.
*/
constructor(dateTime: Date, resource: string);
/**
* Gets the Start or End values of the target appointment.
*/
targetDateTime: Date;
/**
* Gets the time interval of the cell where the button is located.
*/
interval: ASPxClientTimeInterval;
/**
* Gets the resource identifier associated with the cell where the button is located.
*/
resource: string;
/**
* Gets or sets whether an event is handled. If it is handled, default actions are not required.
*/
handled: boolean;
}
/**
* A method that will handle the ASPxClientScheduler.MenuItemClicked event.
* @param source The ASPxClientScheduler control which fires the event.
* @param e A MenuItemClickedEventArgs object that contains event data.
*/
interface MenuItemClickedEventHandler { (source: Sender, e: MenuItemClickedEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.MenuItemClicked event.
*/
declare class MenuItemClickedEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the MenuItemClickedEventArgs class with the specified menu item name.
* @param itemName A string representing the name of the menu item.
*/
constructor(itemName: string);
/**
* Gets the name of the menu item which is clicked.
*/
itemName: string;
/**
* Gets or sets whether an event is handled, and that default actions are not required.
*/
handled: boolean;
}
/**
* A method that will handle the ASPxClientScheduler.AppointmentDrag event.
* @param source The event sender (typically an ASPxClientScheduler object).
* @param e A ASPxClientAppointmentDragEventArgs object that contains event data.
*/
interface AppointmentDragEventHandler { (source: Sender, e: ASPxClientAppointmentDragEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentDrag event.
*/
declare class ASPxClientAppointmentDragEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientAppointmentDragEventArgs class.
* @param mouseEvent A mouse event object related to the drag operation.
* @param dragInformation An array of ASPxClientAppointmentDragInfo objects storing information about dragged appointments.
*/
constructor(mouseEvent: any, dragInformation: ASPxClientAppointmentDragInfo[]);
/**
* Specifies whether or not appointments can be dropped into the intervals over which they are currently dragged.
*/
allow: boolean;
/**
* Gets a mouse event object related to the current drag operation.
*/
mouseEvent: any;
/**
* Provides information about dragged appointments.
*/
dragInformation: ASPxClientAppointmentDragInfo[];
}
/**
* A method that will handle the ASPxClientScheduler.AppointmentDrop event.
* @param source The event sender (typically an ASPxClientScheduler object).
* @param e A ASPxClientAppointmentDropEventArgs object that contains event data.
*/
interface AppointmentDropEventHandler { (source: Sender, e: ASPxClientAppointmentDropEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentDrop event.
*/
declare class ASPxClientAppointmentDropEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientAppointmentDropEventArgs class.
* @param operation An ASPxClientAppointmentOperation object providing methods to perform or cancel the drag operation.
* @param dragInformation An array of ASPxClientAppointmentDragInfo objects storing information about dropped appointments.
*/
constructor(operation: ASPxClientAppointmentOperation, dragInformation: ASPxClientAppointmentDragInfo[]);
/**
* Gets or sets a value that specifies whether the event is handled, and the default processing is not required.
*/
handled: boolean;
/**
* Provides access to an object that enables you to choose an operation to perform.
*/
operation: ASPxClientAppointmentOperation;
/**
* Provides information about dropped appointments.
*/
dragInformation: ASPxClientAppointmentDragInfo[];
}
/**
* A method that will handle the ASPxClientScheduler.AppointmentResize event.
* @param source The event sender (typically an ASPxClientScheduler control).
* @param e A ASPxClientAppointmentResizeEventArgs object that contains event data.
*/
interface AppointmentResizeEventHandler { (source: Sender, e: ASPxClientAppointmentResizeEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentResize event.
*/
declare class ASPxClientAppointmentResizeEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientAppointmentResizeEventArgs class.
* @param operation An ASPxClientAppointmentOperation object providing methods to perform or cancel the resize operation.
* @param appointmentId A string containing an appointment identifier.
* @param oldInterval An object specifying the appointment's interval before the resize operation.
* @param newInterval An object specifying the appointment's interval after the resize operation.
*/
constructor(operation: ASPxClientAppointmentOperation, appointmentId: string, oldInterval: ASPxClientTimeInterval, newInterval: ASPxClientTimeInterval);
/**
* Gets or sets whether default event processing is required.
*/
handled: boolean;
/**
* Provides access to an object that enables you to choose an operation to perform.
*/
operation: ASPxClientAppointmentOperation;
/**
* Gets the resized appointment's identifier.
*/
appointmentId: string;
/**
* Gets the appointment's interval before resizing.
*/
oldInterval: ASPxClientTimeInterval;
/**
* Gets the appointment's interval after resizing.
*/
newInterval: ASPxClientTimeInterval;
}
/**
* A method that will handle the ASPxClientScheduler.AppointmentResizing event.
* @param source The event sender (typically an ASPxClientScheduler object).
* @param e A ASPxClientAppointmentResizingEventArgs object that contains event data.
*/
interface AppointmentResizingEventHandler { (source: Sender, e: ASPxClientAppointmentResizingEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentResizing event.
*/
declare class ASPxClientAppointmentResizingEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientAppointmentResizingEventArgs class.
* @param mouseEvent A mouse event object related to the resizing operation.
* @param appointmentId A string containing an appointment identifier.
* @param oldInterval An object specifying the appointment's interval before the resize operation.
* @param newInterval An object specifying the appointment's interval after the resize operation.
*/
constructor(mouseEvent: any, appointmentId: string, oldInterval: ASPxClientTimeInterval, newInterval: ASPxClientTimeInterval);
/**
* Specifies whether or not an appointment can be resized to the new time interval.
*/
allow: boolean;
/**
* Gets a mouse event object related to the current appointment resizing operation.
*/
mouseEvent: any;
/**
* Gets the resized appointment's identifier.
*/
appointmentId: string;
/**
* Gets the appointment's interval before resizing.
*/
oldInterval: ASPxClientTimeInterval;
/**
* Gets the appointment's interval after resizing.
*/
newInterval: ASPxClientTimeInterval;
}
/**
* Stores information about an appointment drag operation.
*/
declare class ASPxClientAppointmentDragInfo {
/**
* Initializes a new instance of the ASPxClientAppointmentDragInfo class.
* @param appointmentId A string containing an appointment identifier.
* @param oldInterval An ASPxClientTimeInterval object specifying the appointment's interval before the drag operation.
* @param oldResources A array of strings containing identifiers of resources that were associated with the appointment before the drag operation.
* @param newInterval An ASPxClientTimeInterval object specifying the appointment's interval after the drag operation.
* @param newResources A array of strings containing identifiers of resources associated with the appointment after the drag operation.
*/
constructor(appointmentId: string, oldInterval: ASPxClientTimeInterval, oldResources: string[], newInterval: ASPxClientTimeInterval, newResources: string[]);
/**
* Gets the dragged appointment's identifier.
*/
appointmentId: string;
/**
* Gets the appointment's interval before the drag operation.
*/
oldInterval: ASPxClientTimeInterval;
/**
* Gets resources that were associated with the appointment before the drag operation.
*/
oldResources: string[];
/**
* Gets the appointment's interval after the drag operation.
*/
newInterval: ASPxClientTimeInterval;
/**
* Gets resources associated with the appointment after the drag operation.
*/
newResources: string[];
}
/**
* A method that will handle the ASPxClientScheduler.CellClick event.
* @param source The event source.
* @param e A ASPxClientSchedulerCellClickEventArgs object that contains event data
*/
interface CellClickEventHandler { (source: Sender, e: ASPxClientSchedulerCellClickEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.CellClick event.
*/
declare class ASPxClientSchedulerCellClickEventArgs extends ASPxClientEventArgs {
/**
* Gets the HTML element that the event was triggered on.
*/
htmlElement: any;
/**
* Gets the time interval of the time cells related to the event.
*/
interval: ASPxClientTimeInterval;
/**
* Gets the resource identifier associated with the cell related to the event.
*/
resource: string;
}
/**
* A method that will handle the corresponding client event.
* @param source The event source.
* @param e An ASPxClientAppointmentToolTipShowingEventArgs object that contains event data.
*/
interface ASPxClientAppointmentToolTipShowingEventHandler { (source: Sender, e: ASPxClientAppointmentToolTipShowingEventArgs): void; }
/**
* Provides data for the ASPxClientScheduler.AppointmentToolTipShowing event.
*/
declare class ASPxClientAppointmentToolTipShowingEventArgs extends ASPxClientCancelEventArgs {
/**
* Initializes a new instance of the ASPxClientAppointmentToolTipShowingEventArgs class.
* @param appointment An ASPxClientAppointment object representing the appointment.
*/
constructor(appointment: ASPxClientAppointment);
/**
* Gets the appointment.
*/
appointment: ASPxClientAppointment;
}
/**
* Exposes static methods that simplify working with JavaScript DateTime values.
*/
declare class ASPxSchedulerDateTimeHelper {
/**
* Returns the date part of the specified DateTime value. A DateTime object containing a date.
* @param date A DateTime object from which to extract the date.
*/
static TruncToDate(date: Date): Date;
/**
* Returns the day time part of the specified DateTime value. A TimeSpan object containing the day time.
* @param date A DateTime object from which to extract the day time.
*/
static ToDayTime(date: Date): any;
/**
* Adds the specified number of days to a DateTime object and returns the result. A DateTime object.
* @param date A DateTime object to which to add days.
* @param dayCount The number of days to add.
*/
static AddDays(date: Date, dayCount: number): Date;
/**
* Adds the specified timespan to a DateTime object and returns the result. A DateTime object.
* @param date A DateTime object to which to add a timespan.
* @param timeSpan A TimeSpan object specifying the timespan to add.
*/
static AddTimeSpan(date: Date, timeSpan: any): Date;
/**
* Rounds a DateTime value up to the nearest interval. A DateTime object containing the rounded value.
* @param date A DateTime object containing a value to round.
* @param spanInMs A TimeSpan object specifying an interval to which to round.
*/
static CeilDateTime(date: Date, spanInMs: any): Date;
}
/**
* Represents the client-side equivalent of the TimeInterval class.
*/
declare class ASPxClientTimeInterval {
/**
* Initializes a new instance of the ASPxClientTimeInterval class with the specified start time and duration.
* @param start A DateTime object, representing the beginning of the period.
* @param duration A TimeSpan structure, representing a time interval.
*/
constructor(start: Date, duration: any);
/**
* Gets a value indicating if the time interval is All-Day.
*/
GetAllDay(): boolean;
/**
* Sets a value specifying if the time interval is All-Day.
* @param allDayValue true, if this is an all-day time interval; otherwise, false.
*/
SetAllDay(allDayValue: boolean): void;
/**
* Client-side function that returns the start time of the interval.
*/
GetStart(): Date;
/**
* Client-side function that returns the duration of the specified time interval.
*/
GetDuration(): number;
/**
* Client-side function that returns the end time of the interval.
*/
GetEnd(): Date;
/**
* Client-side function that sets the start time of the interval.
* @param value A DateTime value, representing the beginning of the interval.
*/
SetStart(value: Date): void;
/**
* Client-side function that returns the duration of the specified time interval.
* @param value A TimeSpan object, representing the duration of the time period.
*/
SetDuration(value: any): void;
/**
* Client-side function that sets the end time of the interval.
* @param value A DateTime value, representing the end of the interval.
*/
SetEnd(value: Date): void;
/**
* Determines whether the specified object is equal to the current ASPxClientTimeInterval instance. true if the specified object is equal to the current ASPxClientTimeInterval instance; otherwise false.
* @param interval The object to compare with the current object.
*/
Equals(interval: ASPxClientTimeInterval): boolean;
/**
* Checks if the current time interval intersects with the specified time interval. true, if the two time intervals intersect; otherwise, false.
* @param interval A ASPxClientTimeInterval object which represents the time interval to be checked.
*/
IntersectsWith(interval: ASPxClientTimeInterval): boolean;
/**
* Checks if the current time interval intersects with the specified time interval. The boundaries of the time intervals are excluded from the check. true, if the two time intervals intersect; otherwise, false.
* @param interval A ASPxClientTimeInterval object which represents the time interval to be checked.
*/
IntersectsWithExcludingBounds(interval: ASPxClientTimeInterval): boolean;
/**
* Client-side function that determines whether the specified interval is contained within the current one. true if the specified interval is located within the current one; otherwise, false.
* @param interval An ASPxClientTimeInterval object, representing the time interval to check.
*/
Contains(interval: ASPxClientTimeInterval): boolean;
/**
* Calculates the time interval duration. An integer value specifying the interval duration in milliseconds.
* @param start A DateTime value that specifies the start date time value.
* @param end A DateTime value that specifies the end date time value.
*/
static CalculateDuration(start: Date, end: Date): number;
}
/**
* A client point object.
*/
declare class ASPxClientPoint {
/**
* Initializes a new instance of the ASPxClientPoint object. For internal use only.
* @param x An integer value specifying the x-coordinate of the point.
* @param y An integer value specifying the y-coordinate of the point.
*/
constructor(x: number, y: number);
/**
* Gets the point's X-coordinate.
*/
GetX(): number;
/**
* Gets the point's Y-coordinate.
*/
GetY(): number;
}
/**
* A client rectangle object.
*/
declare class ASPxClientRect {
/**
* Initializes a new instance of the ASPxClientRect object. For internal use only.
* @param x An integer value specifying the x-coordinate of the upper-left corner of the rectangle.
* @param y An integer value specifying the y-coordinate of the upper-left corner of the rectangle.
* @param width An integer value specifying the rectangle width.
* @param height An integer value specifying the rectangle height.
*/
constructor(x: number, y: number, width: number, height: number);
/**
* Gets the X-coordinate of the rectangle's left edge.
*/
GetLeft(): number;
/**
* Gets the X-coordinate of the rectangle's right edge.
*/
GetRight(): number;
/**
* Gets the Y-coordinate of the rectangle's top edge.
*/
GetTop(): number;
/**
* Gets the Y-coordinate of the rectangle's bottom edge.
*/
GetBottom(): number;
/**
* Gets the rectangle's width.
*/
GetWidth(): number;
/**
* Gets the rectangle's height.
*/
GetHeight(): number;
}
/**
* Represents a client-side equivalent of the WeekDaysCheckEdit control.
*/
declare class ASPxClientWeekDaysCheckEdit extends ASPxClientControl {
/**
* Gets the selection state of the week day check boxes.
*/
GetValue(): ASPxClientWeekDays;
/**
* Gets the selection state of the week day check boxes.
* @param value An ASPxClientWeekDays object specifying the selection state of the week day check boxes.
*/
SetValue(value: ASPxClientWeekDays): void;
}
/**
* Represents a client-side equivalent of the RecurrenceRangeControl.
*/
declare class ASPxClientRecurrenceRangeControl extends ASPxClientControl {
/**
* Gets the type of the recurrence range.
*/
GetRange(): ASPxClientRecurrenceRange;
/**
* Gets how many times the appointment occurs.
*/
GetOccurrenceCount(): number;
/**
* Gets the recurrence end date.
*/
GetEndDate(): Date;
/**
* Sets the type of the recurrence range.
* @param range An ASPxClientRecurrenceRangeenumeration value that specifies the recurrence range type.
*/
SetRange(range: ASPxClientRecurrenceRange): void;
/**
* Sets how many times the appointment occurs.
* @param occurrenceCount An integer value that specifies how many times the appointment occurs.
*/
SetOccurrenceCount(occurrenceCount: number): void;
/**
* Sets the recurrence end date.
* @param date A JavaScript Date object that specifies the end date for the recurrence.
*/
SetEndDate(date: Date): void;
}
/**
* A base for client equivalents of recurrence controls available in the XtraScheduler library.
*/
declare class ASPxClientRecurrenceControlBase extends ASPxClientControl {
/**
* Returns an object providing access to the ASPxClientRecurrenceControlBase control's editor values.
*/
CreateValueAccessor(): DefaultRecurrenceRuleValuesAccessor;
/**
* Updates values of editors displayed by the ASPxClientRecurrenceControlBase control.
* @param recurrenceInfo An ASPxClientRecurrenceInfo object containing new editor values.
*/
Update(recurrenceInfo: ASPxClientRecurrenceInfo): void;
}
/**
* Represents a client-side equivalent of the DailyRecurrenceControl - a control for specifying the daily recurrence.
*/
declare class ASPxClientDailyRecurrenceControl extends ASPxClientRecurrenceControlBase {
/**
* Returns an object providing access to the ASPxClientDailyRecurrenceControl's editor values.
*/
CreateValueAccessor(): DefaultRecurrenceRuleValuesAccessor;
/**
* Updates values of editors displayed by the ASPxClientDailyRecurrenceControl.
* @param recurrenceInfo An ASPxClientRecurrenceInfo object containing new editor values.
*/
Update(recurrenceInfo: ASPxClientRecurrenceInfo): void;
}
/**
* Represents a client-side equivalent of the WeeklyRecurrenceControl.
*/
declare class ASPxClientWeeklyRecurrenceControl extends ASPxClientRecurrenceControlBase {
/**
* Returns an object providing access to the ASPxClientWeeklyRecurrenceControl's editor values.
*/
CreateValueAccessor(): DefaultRecurrenceRuleValuesAccessor;
/**
* Updates values of editors displayed by the ASPxClientWeeklyRecurrenceControl.
* @param recurrenceInfo An ASPxClientRecurrenceInfo object containing new editor values.
*/
Update(recurrenceInfo: ASPxClientRecurrenceInfo): void;
}
/**
* Represents a client-side equivalent of the MonthlyRecurrenceControl.
*/
declare class ASPxClientMonthlyRecurrenceControl extends ASPxClientRecurrenceControlBase {
/**
* Returns an object providing access to the ASPxClientMonthlyRecurrenceControl's editor values.
*/
CreateValueAccessor(): DefaultRecurrenceRuleValuesAccessor;
/**
* Updates values of editors displayed by the ASPxClientMonthlyRecurrenceControll.
* @param recurrenceInfo An ASPxClientRecurrenceInfo object containing new editor values.
*/
Update(recurrenceInfo: ASPxClientRecurrenceInfo): void;
}
/**
* Represents a client-side equivalent of the YearlyRecurrenceControl.
*/
declare class ASPxClientYearlyRecurrenceControl extends ASPxClientRecurrenceControlBase {
/**
* Returns an object providing access to the ASPxClientYearlyRecurrenceControl's editor values.
*/
CreateValueAccessor(): DefaultRecurrenceRuleValuesAccessor;
/**
* Updates values of editors displayed by the ASPxClientYearlyRecurrenceControl.
* @param recurrenceInfo An ASPxClientRecurrenceInfo object containing new editor values.
*/
Update(recurrenceInfo: ASPxClientRecurrenceInfo): void;
}
/**
* An object providing access to an ASPxClientRecurrenceControlBase control's editor values.
*/
declare class DefaultRecurrenceRuleValuesAccessor {
/**
* Initializes a new instance of the DefaultRecurrenceRuleValuesAccessor object. For internal use only.
*/
constructor(recurrenceControl: ASPxClientRecurrenceControlBase);
/**
* Get the frequency with which the appointment occurs with respect to the appointment's recurrence type.
*/
GetPeriodicity(): number;
/**
* Gets the number of the month's day in which the appointment is scheduled.
*/
GetDayNumber(): number;
/**
* Gets or sets the month's number.
*/
GetMonth(): number;
/**
* Gets the days of the week on which a weekly recurrent appointment is scheduled.
*/
GetWeekDays(): ASPxClientWeekDays;
/**
* Gets the number of the week in a month when an appointment is scheduled.
*/
GetWeekOfMonth(): ASPxClientWeekOfMonth;
}
/**
* An object providing access to an ASPxClientDailyRecurrenceControl's editor values.
*/
declare class DailyRecurrenceValuesAccessor extends DefaultRecurrenceRuleValuesAccessor {
/**
* Initializes a new instance of the DailyRecurrenceValuesAccessor object. For internal use only.
* @param recurrenceControl A ASPxClientRecurrenceControlBase object specifying the required recurrence control.
*/
constructor(recurrenceControl: ASPxClientRecurrenceControlBase);
/**
* Gets the number of days between appointment occurrences.
*/
GetPeriodicity(): number;
/**
* Gets the days of the week to which a daily recurrent appointment is scheduled.
*/
GetWeekDays(): ASPxClientWeekDays;
}
/**
* An object providing access to an ASPxClientWeeklyRecurrenceControl's editor values.
*/
declare class WeeklyRecurrenceValuesAccessor extends DefaultRecurrenceRuleValuesAccessor {
/**
* Initializes a new instance of the WeeklyRecurrenceValuesAccessor object. For internal use only.
* @param recurrenceControl A ASPxClientRecurrenceControlBase object specifying the required recurrence control.
*/
constructor(recurrenceControl: ASPxClientRecurrenceControlBase);
/**
* Gets the number of weeks between appointment occurrences.
*/
GetPeriodicity(): number;
/**
* Gets the days of the week on which a weekly recurrent appointment is scheduled.
*/
GetWeekDays(): ASPxClientWeekDays;
}
/**
* An object providing access to an ASPxClientMonthlyRecurrenceControl's editor values.
*/
declare class MonthlyRecurrenceValuesAccessor extends DefaultRecurrenceRuleValuesAccessor {
/**
* Initializes a new instance of the MonthlyRecurrenceValuesAccessor object. For internal use only.
* @param recurrenceControl A ASPxClientRecurrenceControlBase object specifying the required recurrence control.
*/
constructor(recurrenceControl: ASPxClientRecurrenceControlBase);
/**
* Gets the day of the month on which the appointment is scheduled.
*/
GetDayNumber(): number;
/**
* Gets the number of months between appointment occurrences.
*/
GetPeriodicity(): number;
/**
* Gets the days of the week on which a monthly recurrent appointment is scheduled.
*/
GetWeekDays(): ASPxClientWeekDays;
/**
* Gets the number of the week in a month when an appointment is scheduled.
*/
GetWeekOfMonth(): ASPxClientWeekOfMonth;
}
/**
* An object providing access to an ASPxClientYearlyRecurrenceControl's editor values.
*/
declare class YearlyRecurrenceValuesAccessor extends DefaultRecurrenceRuleValuesAccessor {
/**
* Initializes a new instance of the YearlyRecurrenceValuesAccessor object. For internal use only.
* @param recurrenceControl A ASPxClientRecurrenceControlBase object specifying the required recurrence control.
*/
constructor(recurrenceControl: ASPxClientRecurrenceControlBase);
/**
* Gets the day of the month on which the appointment is scheduled.
*/
GetDayNumber(): number;
/**
* Gets or sets the month's number.
*/
GetMonth(): number;
/**
* Gets the days of the week on which a yearly recurrent appointment is scheduled.
*/
GetWeekDays(): ASPxClientWeekDays;
/**
* Gets or sets the number of a week in a month when an appointment is scheduled.
*/
GetWeekOfMonth(): ASPxClientWeekOfMonth;
}
/**
* Provides base functionality for the ASPxClientScheduler's forms.
*/
declare class ASPxClientFormBase {
/**
* Closes the form.
*/
Close(): void;
/**
* Occurs when the form has been closed.
*/
FormClosed: ASPxClientEvent>;
/**
* Sets the visibility state of the specified form element.
* @param element An object specifying the element whose visibility state should be changed.
* @param isVisible true to display the element; false to hide the element.
*/
SetVisibleCore(element: any, isVisible: boolean): void;
}
/**
* Represents a client-side equivalent of the RecurrenceTypeEdit.
*/
declare class ASPxClientRecurrenceTypeEdit extends ASPxClientRadioButtonList {
/**
* Gets the selected recurrence type.
*/
GetRecurrenceType(): ASPxClientRecurrenceType;
/**
* Sets the selected recurrence type.
* @param recurrenceType An ASPxClientRecurrenceType enumeration value.
*/
SetRecurrenceType(recurrenceType: ASPxClientRecurrenceType): void;
}
/**
* Represents the client-side equivalent of the ASPxDateNavigator control.
*/
declare class ASPxClientDateNavigator extends ASPxClientControl {
/**
* Allows you to provide custom highlighting styles for day cells.
*/
DayCellCustomHighlight: ASPxClientEvent>;
/**
* Occurs when the end user selects another date.
*/
SelectionChanged: ASPxClientEvent>;
/**
* Occurs when the end user changes the visible month.
*/
VisibleMonthChanged: ASPxClientEvent>;
}
/**
* A method that will handle the ASPxClientDateNavigator.DayCellCustomHighlight event.
* @param source The event source.
* @param e A ASPxClientDateNavigatorDayCellCustomHighlightEventArgs object that contains event data.
*/
interface ASPxClientDateNavigatorDayCellCustomHighlightEventHandler { (source: Sender, e: ASPxClientDateNavigatorDayCellCustomHighlightEventArgs): void; }
/**
* Provides data for the ASPxClientDateNavigator.DayCellCustomHighlight event.
*/
declare class ASPxClientDateNavigatorDayCellCustomHighlightEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientDateNavigatorDayCellCustomHighlightEventArgs class.
* @param htmlElement An object representing the HTML element.
* @param date A DateTime object that represents the highlighted date.
* @param appointments An array of ASPxClientAppointment objects that the highlighted day cell contains.
*/
constructor(htmlElement: any, date: Date, appointments: ASPxClientAppointment[]);
/**
* Gets the HTML element that the event was triggered on.
*/
htmlElement: any;
/**
* Provides access to the date object of the processed cell.
*/
date: Date;
/**
* Provides access to the processed appointments.
*/
appointments: ASPxClientAppointment[];
}
/**
* A method that will handle the ASPxClientDateNavigator.VisibleMonthChanged event.
* @param source The event source.
* @param e A ASPxClientDateNavigatorVisibleMonthChangedEventArgs object that contains event data.
*/
interface ASPxClientDateNavigatorVisibleMonthChangedEventHandler { (source: Sender, e: ASPxClientDateNavigatorVisibleMonthChangedEventArgs): void; }
/**
* Provides data for the ASPxClientDateNavigator.VisibleMonthChanged event.
*/
declare class ASPxClientDateNavigatorVisibleMonthChangedEventArgs extends ASPxClientEventArgs {
/**
* Returns the start date of the latest visible month.
*/
startDate: Date;
/**
* Returns the end date of the latest visible month.
*/
endDate: Date;
}
/**
* A method that will handle the ASPxClientDateNavigator.SelectionChanged event.
* @param source The event source.
* @param e A ASPxClientDateNavigatorSelectionChangedEventArgs object that contains event data.
*/
interface ASPxClientDateNavigatorSelectionChangedEventHandler { (source: Sender, e: ASPxClientDateNavigatorSelectionChangedEventArgs): void; }
/**
* Provides data for the ASPxClientDateNavigator.SelectionChanged event.
*/
declare class ASPxClientDateNavigatorSelectionChangedEventArgs extends ASPxClientEventArgs {
/**
* Returns the selected dates related to the event.
*/
selectedDates: Date[];
}
/**
* Contains lists of property names for different appointment types.
*/
declare class AppointmentPropertyNames {
/**
* Gets the list of properties characteristic for appointments of the ASPxAppointmentType.Normal type.
*/
Normal: string;
/**
* Gets the list of properties characteristic for appointments of the ASPxAppointmentType.Pattern type.
*/
Pattern: string;
}
/**
* Contains information about a client tooltip.
*/
declare class ASPxClientSchedulerToolTipData {
/**
* Returns the client appointment for which the tooltip is displayed.
*/
GetAppointment(): ASPxClientAppointment;
/**
* Returns the client time interval for which the tooltip is displayed.
*/
GetInterval(): ASPxClientTimeInterval;
/**
* Returns the resources associated with the appointment for which the tooltip is displayed.
*/
GetResources(): string[];
}
/**
* A client-side equivalent of the ASPxSchedulerToolTipBase control.
*/
declare class ASPxClientToolTipBase {
/**
* Returns the value that indicates whether or not the tooltip can be displayed.
*/
CanShowToolTip(): boolean;
/**
* Ends updating the tooltip content.
* @param toolTipData An ASPxClientSchedulerToolTipData object providing data required to update the tooltip content.
*/
FinalizeUpdate(toolTipData: ASPxClientSchedulerToolTipData): void;
/**
* Updates the tooltip content.
* @param toolTipData An ASPxClientSchedulerToolTipData object providing data required to update the tooltip content.
*/
Update(toolTipData: ASPxClientSchedulerToolTipData): void;
/**
* Closes the tooltip.
*/
Close(): void;
/**
* Gets the tooltip position. An ASPxClientPoint object representing the tooltip position.
* @param bounds An object that represents the tooltip bounds.
*/
CalculatePosition(bounds: any): ASPxClientPoint;
/**
* 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: any): void;
/**
* 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: any): void;
/**
* Returns the string representation of the specified interval. A string containing a textual representation of the interval.
* @param interval An ASPxClientTimeInterval object to convert.
*/
ConvertIntervalToString(interval: ASPxClientTimeInterval): string;
}
/**
* Represents the client-side equivalent of the ASPxSchedulerStorageControl control.
*/
declare class ASPxClientSchedulerStorageControl extends ASPxClientControl {
/**
* Occurs when a callback for server-side processing is initiated.
*/
BeginCallback: ASPxClientEvent>;
/**
* Occurs on the client side after a callback's server-side processing has been completed.
*/
EndCallback: ASPxClientEvent>;
/**
* Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientSchedulerStorageControl.
*/
CallbackError: ASPxClientEvent>;
/**
* Occurs when a reminder is invoked.
*/
ReminderAlert: ASPxClientEvent>;
/**
* Retrieves the collection of appointments that are in the specified time interval and are assigned to the specified resources.
* @param onSuccess A client action to perform if the server round-trip completed successfully.
* @param interval An ASPxClientTimeInterval object specifying the required time interval.
* @param resources An array of string values representing the resources' IDs.
*/
GetAppointments(onSuccess: (arg: string) => void, interval: ASPxClientTimeInterval, resources?: string[]): void;
/**
* Client-side function that returns an appointment with the specified ID.
* @param onSuccess A handler of a function which will receive and process the appointments.
* @param appointmentId An appointment's identifier.
*/
GetAppointmentById(onSuccess: (arg: string) => void, appointmentId: string): void;
/**
* Retrieves the collection of resources.
* @param onSuccess A client action to perform if the server round-trip has completed successfully.
*/
GetResources(onSuccess: (arg: string) => void): void;
/**
* Returns the resource by its ID.
* @param onSuccess A handler of a function which will receive and process the properties' values.
* @param resourceId A string value specifying the resource ID.
*/
GetResourceById(onSuccess: (arg: string) => void, resourceId: string): void;
/**
* Client-side scripting method to insert the specified appointment.
* @param appointment An ASPxClientAppointment object representing the client-side appointment.
*/
InsertAppointment(appointment: ASPxClientAppointment): void;
/**
* Client-side scripting method to update the specified appointment.
* @param appointment An ASPxClientAppointment object representing the client-side appointment.
*/
UpdateAppointment(appointment: ASPxClientAppointment): void;
/**
* Client-side scripting method to delete the specified appointment.
* @param appointment An ASPxClientAppointment object representing the client-side appointment.
*/
DeleteAppointment(appointment: ASPxClientAppointment): void;
/**
* Dismisses all reminders.
*/
DismissAllReminders(): void;
/**
* Snoozes all reminders.
*/
SnoozeAllReminders(): void;
/**
* Client-side scripting method which initiates a round trip to the server, so that the control will be reloaded.
*/
Refresh(): void;
}
/**
* Lists values that identify the context menu type.
*/
declare enum ASPxClientSpreadsheetPopupMenuType {
/**
* Specifies a context menu which can be invoked by right-clicking a column header.
*/
ColumnHeading = 0,
/**
* Specifies a context menu which can be invoked by right-clicking a row header.
*/
RowHeading = 1,
/**
* Specifies a context menu which can be invoked by right-clicking a worksheet tab.
*/
SheetTab = 3,
/**
* Specifies a context menu which can be invoked by right-clicking a picture embedded in a worksheet.
*/
Picture = 4,
/**
* Specifies a context menu which can be invoked by right-clicking a chart in a worksheet.
*/
Chart = 5,
/**
* Specifies a context menu which can be invoked by right-clicking any cell in a worksheet.
*/
Cell = 7,
/**
* Specifies a context menu which can be invoked by clicking the AutoFilter drop-down arrow.
*/
AutoFilter = 8,
/**
* Specifies a context menu which can be invoked by right-clicking any cell in a pivot table.
*/
PivotTable = 9,
/**
* Specifies a context menu which can be invoked by clicking the AutoFilter drop-down arrow on the row or column label of a pivot table.
*/
PivotTableAutoFilter = 10
}
/**
* Lists values identifying a type of the element currently being edited in the Spreadsheet control.
*/
declare enum ASPxClientSpreadsheetEditMode {
/**
* Specifies that no elements are currently being edited.
*/
None = 0,
/**
* Specifies that the element currently being edited is the spreadsheet cell.
*/
Cell = 1,
/**
* Specifies that the element currently being edited is the cell's comment.
*/
Comment = 2,
}
/**
* Lists values identifying the Spreadsheet's view modes.
*/
declare enum ASPxClientSpreadsheetViewMode {
/**
* Specifies that the Spreadsheet is in Editing view mode. In this view mode, users can edit a document's content.
*/
Editing = 0,
/**
* Specifies that the Spreadsheet is in Reading view mode. In this view mode, users cannot edit a document's content.
*/
Reading = 1,
}
/**
* Contains settings specifying size and position of a spreadsheet cell's in-place editor.
*/
declare class ASPxClientSpreadsheetRectangle {
/**
* Gets the x-coordinate of the specified cell's left side.
*/
x: number;
/**
* Gets the y-coordinate of the specified cell's top side.
*/
y: number;
/**
* Gets the width value of the cell's in-place editor.
*/
width: number;
/**
* Gets the height value of the cell's in-place editor.
*/
height: number;
/**
* Gets the x-coordinate of the specified cell's editor.
*/
left: number;
/**
* Gets the y-coordinate of the specified cell's editor.
*/
top: number;
/**
* Gets the y-coordinate of the specified cell's bottom side.
*/
bottom: number;
/**
* Gets the x-coordinate of the specified cell's right side.
*/
right: number;
}
/**
* A method that will handle the ASPxClientSpreadsheet.CellBeginEdit event.
* @param source An object representing the event source. Identifies the Spreadsheet that raised the event.
* @param e A ASPxClientSpreadsheetCellBeginEditEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetCellBeginEditEventHandler { (source: Sender, e: ASPxClientSpreadsheetCellBeginEditEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.CellBeginEdit event.
*/
declare class ASPxClientSpreadsheetCellBeginEditEventArgs extends ASPxClientCancelEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetCellBeginEditEventArgs object. For internal use only.
* @param columnIndex Gets the active cell's column index.
* @param rowIndex Gets the active cell's row index.
* @param formula Gets the active cell's formula.
* @param value Gets the active cell's current value.
* @param sheetName Gets the current worksheet's name.
*/
constructor(columnIndex: number, rowIndex: number, formula: string, value: string, sheetName: string);
/**
* Gets the active cell's column index.
*/
columnIndex: number;
/**
* Gets the active cell's row index.
*/
rowIndex: number;
/**
* Gets the active cell's formula.
*/
formula: string;
/**
* Gets the active cell's current value.
*/
value: string;
/**
* Gets the current worksheet's name.
*/
sheetName: string;
}
/**
* A method that will handle the ASPxClientSpreadsheet.CellEndEdit event.
* @param source An object representing the event source. Identifies the Spreadsheet that raised the event.
* @param e A ASPxClientSpreadsheetCellEndEditEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetCellEndEditEventHandler { (source: Sender, e: ASPxClientSpreadsheetCellEndEditEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.CellEndEdit event.
*/
declare class ASPxClientSpreadsheetCellEndEditEventArgs extends ASPxClientSpreadsheetCellBeginEditEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetCellEndEditEventArgs object. For internal use only.
* @param columnIndex Gets the active cell's column index.
* @param rowIndex Gets the active cell's row index.
* @param formula Gets the active cell's formula.
* @param value Gets the active cell's current value.
* @param sheetName Gets the current worksheet's name.
* @param editorText Gets or sets the text stored within an active cell's editor.
*/
constructor(columnIndex: number, rowIndex: number, formula: string, value: string, sheetName: string, editorText: string);
/**
* Gets or sets the text stored within the active cell's editor.
*/
editorText: string;
}
/**
* A method that will handle the ASPxClientSpreadsheet.CellCancelEdit event.
* @param source An object representing the event source. Identifies the Spreadsheet that raised the event.
* @param e A ASPxClientSpreadsheetCellCancelEditEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetCellCancelEditEventHandler { (source: Sender, e: ASPxClientSpreadsheetCellCancelEditEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.CellCancelEdit event.
*/
declare class ASPxClientSpreadsheetCellCancelEditEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetCellCancelEditEventArgs object. For internal use only.
* @param columnIndex Gets the active cell's column index.
* @param rowIndex Gets the active cell's row index.
* @param formula Gets the active cell's formula.
* @param value Gets the active cell's current value.
* @param sheetName Gets the current worksheet's name.
*/
constructor(columnIndex: number, rowIndex: number, formula: string, value: string, sheetName: string);
/**
* Gets the active cell's column index.
*/
columnIndex: number;
/**
* Gets the active cell's row index.
*/
rowIndex: number;
/**
* Gets the active cell's formula.
*/
formula: string;
/**
* Gets the active cell's current value.
*/
value: string;
/**
* Gets the current worksheet's name.
*/
sheetName: string;
}
/**
* A method that will handle the ASPxClientSpreadsheet.SelectionChanged event.
* @param source An object representing the event source. Identifies the button editor that raised the event.
* @param e An ASPxClientSpreadsheetSelectionChangedEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetSelectionChangedEventHandler { (source: Sender, e: ASPxClientSpreadsheetSelectionChangedEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.SelectionChanged event.
*/
declare class ASPxClientSpreadsheetSelectionChangedEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetSelectionChangedEventArgs within the specified setting.
* @param selection An ASPxClientSpreadsheetSelection object defining the selection in the Spreadsheet.
*/
constructor(selection: ASPxClientSpreadsheetSelection);
/**
* Gets an object that determines the currently selected region within the Spreadsheet.
*/
selection: ASPxClientSpreadsheetSelection;
}
/**
* Represents the selection in the Spreadsheet.
*/
declare class ASPxClientSpreadsheetSelection {
/**
* Gets the column index of the active cell.
*/
activeCellColumnIndex: number;
/**
* Gets the row index of the active cell.
*/
activeCellRowIndex: number;
/**
* Gets the index of the selection's left column.
*/
leftColumnIndex: number;
/**
* Gets the index of the selection's top row.
*/
topRowIndex: number;
/**
* Gets the index of the selection's right column.
*/
rightColumnIndex: number;
/**
* Gets the index of the selection's bottom row.
*/
bottomRowIndex: number;
}
/**
* A method that will handle the ASPxClientSpreadsheet.CustomCommandExecuted event.
* @param source An object representing the event source. Identifies the Spreadsheet that raised the event.
* @param e A ASPxClientSpreadsheetCustomCommandExecutedEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetCustomCommandExecutedEventHandler { (source: Sender, e: ASPxClientSpreadsheetCustomCommandExecutedEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.CustomCommandExecuted event.
*/
declare class ASPxClientSpreadsheetCustomCommandExecutedEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetCustomCommandExecutedEventArgs class.
* @param commandName A string value that specifies the name of the processed command.
* @param parameter An object that can contain command specific information needed for handling the command execution.
*/
constructor(commandName: string, parameter: any);
/**
* Gets the name of the processed command.
*/
commandName: string;
/**
* Gets an optional parameter that complements the processed command.
*/
parameter: string;
/** @deprecated This property is now obsolete. Use the commandName property instead. */
/**
* This property is now obsolete. Use the ASPxClientSpreadsheetCustomCommandExecutedEventArgs.commandName property instead.
*/
item: ASPxClientRibbonItem;
}
/**
* A method that will handle the ASPxClientSpreadsheet.DocumentChanged event.
* @param source An object representing the event source. Identifies the Spreadsheet that raised the event.
* @param e A ASPxClientSpreadsheetDocumentChangedEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetDocumentChangedEventHandler { (source: Sender, e: ASPxClientSpreadsheetDocumentChangedEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.DocumentChanged event.
*/
declare class ASPxClientSpreadsheetDocumentChangedEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetDocumentChangedEventArgs class.
*/
constructor();
}
/**
* A method that will handle the ASPxClientSpreadsheet.BeginSynchronization and ASPxClientSpreadsheet.EndSynchronization events.
* @param source An object representing the event source. Identifies the Spreadsheet that raised the event.
* @param e A ASPxClientSpreadsheetSynchronizationEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetSynchronizationEventHandler { (source: Sender, e: ASPxClientSpreadsheetSynchronizationEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.BeginSynchronization and ASPxClientSpreadsheet.EndSynchronization events.
*/
declare class ASPxClientSpreadsheetSynchronizationEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetSynchronizationEventArgs class.
*/
constructor();
}
/**
* A method that will handle the ASPxClientSpreadsheet.HyperlinkClick event.
* @param source An object representing the event source. Identifies the Spreadsheet that raised the event.
* @param e An ASPxClientSpreadsheetHyperlinkClickEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetHyperlinkClickEventHandler { (source: Sender, e: ASPxClientSpreadsheetHyperlinkClickEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.HyperlinkClick event.
*/
declare class ASPxClientSpreadsheetHyperlinkClickEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetHyperlinkClickEventArgs object. For internal use only.
* @param htmlEvent A DHTML event object that relates to the processed event.
* @param handled true if the event is handled and no default processing is required; otherwise false.
* @param hyperlinkType One of the ASPxClientOfficeDocumentLinkType values.
* @param targetUri A sting value specifying the link's URI.
*/
constructor(htmlEvent: any, handled: boolean, hyperlinkType: ASPxClientOfficeDocumentLinkType, targetUri: string);
/**
* Gets or sets a value that specifies whether the event is handled, and the default processing is not required.
*/
handled: boolean;
/**
* Gets a DHTML event object that relates to the processed event.
*/
htmlEvent: any;
/**
* Gets a value identifying the clicked hyperlink type.
*/
hyperlinkType: ASPxClientOfficeDocumentLinkType;
/**
* Gets the clicked link's URI.
*/
targetUri: string;
}
/**
* A method that will handle the ASPxClientSpreadsheet.PopupMenuShowing event.
* @param source The event sender (typically an ASPxClientSpreadsheet object).
* @param e A ASPxClientSpreadsheetPopupMenuShowingEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetPopupMenuShowingEventHandler { (source: Sender, e: ASPxClientSpreadsheetPopupMenuShowingEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.PopupMenuShowing event.
*/
declare class ASPxClientSpreadsheetPopupMenuShowingEventArgs extends ASPxClientCancelEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetPopupMenuShowingEventArgs class with the specified settings.
* @param menuItems Provides access to the context menu's item collection.
* @param menuType Specifies the currently displayed context menu's type.
*/
constructor(menuItems: any, menuType: any);
/**
* Provides access to a collection of menu items in the context menu being invoked.
*/
menuItems: ASPxClientSpreadsheetPopupMenuItemCollection;
/**
* Gets the currently displayed context menu's type.
*/
menuType: ASPxClientSpreadsheetPopupMenuType;
}
/**
* A method that will handle the ASPxClientSpreadsheet.ViewModeChanged event.
* @param source The event sender (typically an ASPxClientSpreadsheet object).
* @param e A ASPxClientSpreadsheetViewModeChangedEventArgs object that contains event data.
*/
interface ASPxClientSpreadsheetViewModeChangedEventHandler { (source: Sender, e: ASPxClientSpreadsheetViewModeChangedEventArgs): void; }
/**
* Provides data for the ASPxClientSpreadsheet.ViewModeChanged event.
*/
declare class ASPxClientSpreadsheetViewModeChangedEventArgs extends ASPxClientEventArgs {
/**
* Initializes a new instance of the ASPxClientSpreadsheetViewModeChangedEventArgs class.
* @param oldViewMode Specifies the control's current view mode.
*/
constructor(oldViewMode: any);
/**
* Gets the control's current view mode when the event is triggered.
*/
oldViewMode: ASPxClientSpreadsheetViewMode;
}
/**
* A client-side equivalent of the ASPxSpreadsheet object.
*/
declare class ASPxClientSpreadsheet extends ASPxClientControl {
/**
* Occurs when a callback for server-side processing is initiated.
*/
BeginCallback: ASPxClientEvent>;
/**
* Occurs on the client side after a callback's server-side processing has been completed.
*/
EndCallback: ASPxClientEvent>;
/**
* Fires on the client if any server error occurs during server-side processing of a callback sent by the ASPxClientSpreadsheet.
*/
CallbackError: ASPxClientEvent>;
/**
* Occurs on the client when a selection is changed in the ASPxSpreadsheet.
*/
SelectionChanged: ASPxClientEvent>;
/**
* Occurs after a custom command has been executed on the client side.
*/
CustomCommandExecuted: ASPxClientEvent>;
/**
* Fires if any change is made to the Spreadsheet's document on the client.
*/
DocumentChanged: ASPxClientEvent>;
/**
* Fires after a client change has been made to the document and the client-server synchronization starts to apply the change on the server.
*/
BeginSynchronization: ASPxClientEvent>;
/**
* Fires after a document change has been applied to the server and server and client document models have been synchronized.
*/
EndSynchronization: ASPxClientEvent>;
/**
* Occurs when the control's view mode is changed.
*/
ViewModeChanged: ASPxClientEvent>;
/**
* Occurs on the client side after a hyperlink is clicked within the Spreadsheet's document.
*/
HyperlinkClick: ASPxClientEvent>;
/**
* Occurs before the context menu is displayed and allows menu customization.
*/
PopupMenuShowing: ASPxClientEvent>;
/**
* Occurs before the cell editor is opened.
*/
CellBeginEdit: ASPxClientEvent>;
/**
* Occurs before the cell editor is closed and the entered value is committed.
*/
CellEndEdit: ASPxClientEvent>;
/**
* Occurs before the active cell's editor is closed and the entered value is rolled back.
*/
CellCancelEdit: ASPxClientEvent>;
/**
* Occurs when attempting to edit a locked cell in a protected worksheet.
*/
ProtectionWarning: ASPxClientEvent>;
/**
* Sets input focus to the Spreadsheet.
*/
Focus(): void;
/**
* Gets access to the client ribbon object.
*/
GetRibbon(): ASPxClientRibbon;
/**
* Enables you to switch the full-screen mode of the Spreadsheet.
* @param fullscreen true to activate full-screen mode; false to deactivate full-screen mode.
*/
SetFullscreenMode(fullscreen: boolean): void;
/**
* Returns the control's view mode.
*/
GetViewMode(): ASPxClientSpreadsheetViewMode;
/**
* Specifies the control's view mode.
* @param mode A value specifying the control's view mode.
*/
SetViewMode(mode: ASPxClientSpreadsheetViewMode): void;
/**
* Returns the type of the element currently being edited in the Spreadsheet control.
*/
GetEditMode(): ASPxClientSpreadsheetEditMode;
/**
* Applies a value stored within the editor to the active cell
*/
ApplyCellEdit(): void;
/**
* Cancels editing of the active cell.
*/
CancelCellEdit(): void;
/**
* Specifies the editor's value of the edited cell.
* @param text A string specifying text received by the cell's editor.
*/
SetCellEditorText(text: string): void;
/**
* Gets a name of the worksheet that is currently displayed within the spreadsheet.
*/
GetActiveSheetName(): string;
/**
* Returns the current selection made in a Spreadsheet.
*/
GetSelection(): ASPxClientSpreadsheetSelection;
/**
* Invokes the browser print dialog to print the sheet content.
* @param target The target name.
*/
Print(target: string): void;
/**
* Indicates whether any unsaved changes are contained in the current document.
*/
HasUnsavedChanges(): boolean;
/**
* Gets the value of the specified cell. An object representing the specified cell's value.
* @param colModelIndex An integer value specifying the cell's column index.
* @param rowModelIndex An integer value specifying the cell's row index.
*/
GetCellValue(colModelIndex: number, rowModelIndex: number): any;
/**
* Gets the specified cell's bounds. An ASPxClientSpreadsheetRectangle instance defining the rectangle with the specified position and size.
* @param colModelIndex An integer value specifying the zero-based column index.
* @param rowModelIndex An integer value specifying the zero-based row index.
*/
GetCellBounds(colModelIndex: number, rowModelIndex: number): ASPxClientSpreadsheetRectangle;
/**
* Returns the comment associated with the specified data cell. An object representing the specified cell's comment.
* @param colModelIndex An integer value specifying the data cell's column index.
* @param rowModelIndex An integer value specifying the data cell's row index.
*/
GetCellComment(colModelIndex: number, rowModelIndex: number): any;
/**
* Gets the value of the currently active cell.
*/
GetActiveCellValue(): any;
/**
* Sends a callback to the server and generates the server-side ASPxSpreadsheet.Callback event, passing it the specified argument.
* @param parameter A string value that represents any information that needs to be sent to the server-side event.
* @param onSuccess A client action to perform if the server round-trip completed successfully.
*/
PerformCallback(parameter: string, onSuccess?: (arg: string) => void): void;
/** @deprecated Use the PerformCallback method instead. */
/**
* Sends a callback to the server and generates the server-side ASPxSpreadsheet.DocumentCallback event, passing it the specified argument.
* @param parameter A string value that represents any information that needs to be sent to the server-side ASPxSpreadsheet.DocumentCallback event.
*/
PerformDocumentCallback(parameter: string): void;
/**
* Reconnects the Spreadsheet to an external ribbon.
*/
ReconnectToExternalRibbon(): void;
/**
* Converts the specified object to the ASPxClientSpreadsheet type. The converted client object specified by the obj parameter.
* @param obj The client object to be type cast.
*/
static Cast(obj: any): ASPxClientSpreadsheet;
}
/**
* Represents an individual item of the Spreadsheet's context menu.
*/
declare class ASPxClientSpreadsheetPopupMenuItem {
/**
* Gets the immediate parent menu item to which the current menu item belongs.
*/
parent: ASPxClientSpreadsheetPopupMenuItem;
/**
* Gets or sets the unique identifier name for the current menu item.
*/
name: string;
/**
* Gets or sets the text content of the current 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.
*/
enabled: boolean;
/**
* Gets or sets the CSS class name defining the menu item's image.
*/
imageClassName: string;
/**
* Gets or sets an URL which defines the navigation location.
*/
navigateUrl: string;
/**
* Gets or sets the URL of the menu item's image.
*/
imageUrl: string;
/**
* Gets or sets a value that specifies whether the current menu item starts a group.
*/
beginGroup: boolean;
/**
* Gets or sets the current menu item's tooltip text.
*/
tooltip: string;
/**
* Gets or sets the window or frame at which to target the contents of the URL associated with the current menu item.
*/
target: string;
/**
* Gets a collection that contains the submenu items of the current menu item.
*/
GetSubItems(): ASPxClientSpreadsheetPopupMenuItemCollection;
/**
* Returns the menu item's sub-item with the specified index. An ASPxClientSpreadsheetPopupMenuItem object representing the found sub-item.
* @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): ASPxClientSpreadsheetPopupMenuItem;
/**
* Returns the menu item's sub-item with the specified ASPxClientSpreadsheetPopupMenuItem.name property value. An ASPxClientSpreadsheetPopupMenuItem object representing the found sub-item.
* @param name A string value specifying the ASPxClientSpreadsheetPopupMenuItem.name property value of the sub-item to find.
*/
GetItemByName(name: string): ASPxClientSpreadsheetPopupMenuItem;
/**
* Returns the total number of the menu item's child items (submenu items).
*/
GetItemCount(): number;
}
/**
* Represents a collection of items in the Spreadsheet's context menu.
*/
declare class ASPxClientSpreadsheetPopupMenuItemCollection {
/**
* Adds the specified menu item to the end of the collection.
* @param item An ASPxClientSpreadsheetPopupMenuItem object specifying the item to be added to the collection.
*/
Add(item: ASPxClientSpreadsheetPopupMenuItem): 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 ASPxClientSpreadsheetPopupMenuItem.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 ASPxClientSpreadsheetPopupMenuItem object to insert.
*/
Insert(index: number, item: ASPxClientSpreadsheetPopupMenuItem): void;
/**
* Returns the total number of menu items in the collection.
*/
GetCount(): number;
/**
* Returns an item object with the specified ASPxClientSpreadsheetPopupMenuItem.name property value. An ASPxClientSpreadsheetPopupMenuItem object with a specific value of the ASPxClientSpreadsheetPopupMenuItem.name property.
* @param name A string value representing the ASPxClientSpreadsheetPopupMenuItem.name property value of the required item.
*/
GetByName(name: string): ASPxClientSpreadsheetPopupMenuItem;
/**
* Returns a menu item specified by its index in the collection. A ASPxClientSpreadsheetPopupMenuItem object that is a menu item with the specified index.
* @param index An integer value that is the zero-based index of the ASPxClientSpreadsheetPopupMenuItem to retrieve from the ASPxClientSpreadsheetPopupMenuItemCollection.
*/
Get(index: number): ASPxClientSpreadsheetPopupMenuItem;
/**
* Removes all menu items from the collection.
*/
Clear(): void;
}
/**
* A client-side equivalent of the ASPxGantt control.
*/
declare class ASPxClientGantt extends ASPxClientTreeList {
/**
* Sets a view to display tasks.
* @param viewType Lists views to display tasks.
*/
SetViewType(viewType: ASPxClientGanttViewType): void;
/**
* Sets a task's title position.
* @param position Lists title positions.
*/
SetTaskTitlePosition(position: ASPxClientGanttTaskTitlePosition): void;
/**
* Shows resources for tasks.
* @param value true to display resources; otherwise, false.
*/
ShowResources(value: boolean): void;
batchEditApi: ASPxClientTreeListBatchEditApi;
AutoFilterByColumn(column: ASPxClientTreeListColumn | number | string, val: string): void;
FocusEditor(column: ASPxClientTreeListColumn | number | string): void;
GetAutoFilterEditor(column: ASPxClientTreeListColumn | number | string): any;
GetEditValue(column: ASPxClientTreeListColumn | number | string): any;
GetEditor(column: ASPxClientTreeListColumn | number | string): any;
GetSelectedNodeValues(fieldNames: string | string[], onCallback: ASPxClientTreeListValuesCallback, visibleOnly?: boolean): void;
SelectNode(nodeKey: string, state?: boolean): void;
SetEditValue(column: ASPxClientTreeListColumn | number | string, value: any): void;
StartEditNewNode(parentNodeKey?: string): void;
ApplyFilter(filterExpression: string): void;
ApplyOnClickRowFilter(): void;
ApplySearchPanelFilter(value: string): void;
CancelEdit(): void;
ClearFilter(): void;
CloseFilterControl(): void;
DeleteNode(nodeKey: string): void;
ExportTo(format: ASPxClientTreeListExportFormat): void;
GetEditingNodeKey(): string;
GetFocusedCell(): ASPxClientTreeListCellInfo;
GetPageCount(): number;
GetPageIndex(): number;
GetPopupEditForm(): ASPxClientPopupControl;
GetToolbar(index: number): ASPxClientMenu;
GetToolbarByName(name: string): ASPxClientMenu;
GetVisibleSelectedNodeKeys(): string[];
GoToPage(index: number): void;
IsEditing(): boolean;
IsNodeSelected(nodeKey: string): boolean | null;
MoveNode(nodeKey: string, parentNodeKey: string): void;
NextPage(): void;
PrevPage(): void;
SetFilterEnabled(isFilterEnabled: boolean): void;
SetFocusedCell(nodeKey: string, columnIndex: number): void;
SetSearchPanelCustomEditor(editor: ASPxClientEdit): void;
ShowFilterControl(): void;
StartEdit(nodeKey: string): void;
UpdateEdit(): void;
BatchEditChangesCanceling: ASPxClientEvent>;
BatchEditChangesSaving: ASPxClientEvent>;
BatchEditConfirmShowing: ASPxClientEvent>;
BatchEditEndEditing: ASPxClientEvent>;
BatchEditNodeDeleting: ASPxClientEvent>;
BatchEditNodeInserting: ASPxClientEvent>;
BatchEditNodeRecovering: ASPxClientEvent>;
BatchEditNodeValidating: ASPxClientEvent>;
BatchEditStartEditing: ASPxClientEvent>;
BatchEditTemplateCellFocused: ASPxClientEvent