WBS Core, Dodeca 8.3

Events

Activated

Occurs when the view is activated.

ActiveSheetChanged

Occurs after the active sheet has changed.

ActiveSheetChanging

Occurs before the active sheet changes.

Property Description

ActivatedSheetIndex

Zero-based index of the activated sheet.

AfterBuild

Occurs after the view has been built.

AfterCascadeSheetBuild

Occurs after a cascade sheet has been added and the tokens have been replaced on the sheet.

Property Description

SheetName

The name of the cascade sheet.

AfterCascadeSheetsBuild

Occurs after the cascade sheets have been built.

Property Description

CascadeSheetNames

A "/" delimited list of the names of the sheets created.

AfterCascadeSummarySheetBuild

Occurs after the cascade summary sheet is built.

Since version 8.0

Property Description

CascadeSheetNames

A "/" delimited list of the names of the sheets created.

AfterClose

Occurs after the view closes.

AfterCommentDeleted

Occurs after a comment has been deleted.

Property Description

CommentId

The unique ID assigned to the comment.

CommentText

The text of the comment.

Context

The context assigned to the comment.

CreatedBy

The user who created the comment.

CreatedDate

The string representation of the date the comment was created.

KeyHash

The unique key that represents the sorted key item combinations.

ParentId

The ID of the parent comment.

Subject

The subject of the comment.

UpdatedBy

The user who last updated the comment.

UpdatedDate

The string representation of the date the comment was last updated.

AfterCommentSaved

Occurs after a comment has been saved.

Property Description

CommentId

The unique ID assigned to the comment.

CommentText

The text of the comment.

Context

The context assigned to the comment.

CreatedBy

The user who created the comment.

CreatedDate

The string representation of the date the comment was created.

KeyHash

The unique key that represents the sorted key item combinations.

ParentId

The ID of the parent comment.

Subject

The subject of the comment.

UpdatedBy

The user who last updated the comment.

UpdatedDate

The string representation of the date the comment was last updated.

AfterCommentsSaved

Occurs after the view's comments have been saved.

AfterCommentsSetup

Occurs after the view's comments have been setup.

AfterConstruct

Occurs after the view instance is created, but before the view user-interface is initialized. Allows for modifying view properties that affect the user-interface.

AfterDataSetRangeBuild

Occurs after a SQLPassthroughDataSetRanges has been built.

Since version 8.0

Property Description

DataSetRangeName

Name of the SQLPassthroughDataSetRange.

DataSetID

ID of the SQLPassthroughDataSet associated with the DataSetRange.

SheetName

When the SQLPassthroughDataSet is used for a cascaded view, the name of the current sheet.

AfterDataSetRangeSave

Occurs after a SQLPassthroughDataSetRange's changes have been saved.

Property Description

DataSetRangeName

Name of the saved SQLPassthroughDataSetRange.

AfterDataSetRangesBuild

Occurs after all the SQLPassthroughDataSetRanges have been built.

AfterDataSetRangesSave

Occurs after all SQLPassthroughDataSetRanges' changes have been saved.

Since version 8.0

AfterDataTableRangeAddRow

Occurs after a row (or rows) is added to a DataTableRange either by a user adding/inserting a row(s) or when an empty row is automatically added.

Property Description

DataTableRangeName

Name of the DataTableRange.

DataSetRangeName

Name of the SQLPassthroughDataSetRange.

DataSheetRangeName

Name of the data sheet range that contains the row(s).

DataRowAddress

The address of the row(s) within the data sheet range.

DataBlockSheetRangeName

If configured for the DataTableRange, the name of the data block sheet range that contains the row(s).

DataBlockRowAddress

The address of the row(s) within the data block sheet range.

SheetName

The name of the sheet that contains the row(s).

AfterDataTableRangeDeleteRow

Occurs after a row (or rows) is deleted from a DataTableRange.

Property Description

DataTableRangeName

Name of the DataTableRange.

DataSetRangeName

Name of the SQLPassthroughDataSetRange.

DataSheetRangeName

Name of the data sheet range that contains the row(s).

DataBlockSheetRangeName

If configured for the DataTableRange, the name of the data block sheet range that contains the row(s).

SheetName

The name of the sheet that contains the row(s).

AfterEmailSend

Occurs after an email is sent.

Since version 8.3

Property Description

ToAddress

The addressee of the email.

CcAddress

The addresses of the email's CC list.

BccAddress

The addresses of the email's BCC list.

FromAddress

The specified from-address.

Subject

The subject of the email message.

MessageBody

The message text of the email.

Attachments

A semicolon delimited list of the names of files attached to the email.

Source

The source of the email send, whether a WorkbookScript Procedure or a tool controller.

AfterExcelTemplatePullToClient

Occurs after the Excel template has been pulled from the server, but before it has been opened.

AfterExportToExcel

Occurs after the view is saved as an Excel file.

AfterImportFromExcel

Occurs after the view is loaded from an external workbook.

Property Description

WorkbookName

The name of the imported workbook, including the extension.

AfterImportWorksheet

Occurs after a worksheet is loaded from an external workbook.

Property Description

SheetName

The name of the imported worksheet.

WorkbookName

The name of the imported workbook, including the extension.

AfterInitializeUI

Occurs after the view UI is initialized.

AfterOpenInExcel

Occurs after the workbook is opened in Excel.

AfterRefresh

Occurs after the view has been built.

AfterSaveAsExcel

Occurs after the workbook is saved as Excel.

AfterSaveAsPdf

Occurs after a view's grid data is saved as a PDF.

AfterWorkbookClose

Occurs after the workbook is closed.

AfterWorkbookOpen

Occurs after the workbook is opened.

BeforeAutoCompleteRangeListLoad

Occurs before an auto-complete range's list of cell values is loaded.

Since version 8.3

Property Description

Name

The name of the AutoCompleteRange.

SheetRangeName

The name of the sheet range associated with the AutoCompleteRange.

BeforeBuild

Occurs immediately after the Build view button is clicked and the view is covered.

BeforeBuildExecute

Occurs immediately after the Build view button is clicked, but before the view is covered.

BeforeCascadeSheetBuild

Occurs before a cascade sheet is added.

Since version 7.2

Property Description

SheetName

The name of the cascade sheet to be added if the event is not canceled.

BeforeCascadeSheetsBuild

Occurs before the cascade sheets are built.

BeforeCascadeSummarySheetBuild

Occurs after the cascade sheets have been built, but before the cascade summary sheet is built.

BeforeClose

Occurs before the view is closed.

BeforeCommentDeleted

Occurs before a comment is deleted.

Property Description

CommentId

The unique ID assigned to the comment.

CommentText

The text of the comment.

Context

The context assigned to the comment.

CreatedBy

The user who created the comment.

CreatedDate

The string representation of the date the comment was created.

KeyHash

The unique key that represents the sorted key item combinations.

ParentId

The ID of the parent comment.

Subject

The subject of the comment.

UpdatedBy

The user who last updated the comment.

UpdatedDate

The string representation of the date the comment was last updated.

BeforeCommentSaved

Occurs before a comment is saved.

Property Description

CommentId

The unique ID assigned to the comment.

CommentText

The text of the comment.

Context

The context assigned to the comment.

CreatedBy

The user who created the comment.

CreatedDate

The string representation of the date the comment was created.

KeyHash

The unique key that represents the sorted key item combinations.

ParentId

The ID of the parent comment.

Subject

The subject of the comment.

UpdatedBy

The user who last updated the comment.

UpdatedDate

The string representation of the date the comment was last updated.

BeforeCommentsSaved

Occurs before the view's comments are saved.

BeforeCommentsSetup

Occurs before the view's comments are setup.

BeforeDataSetRangeBuild

Occurs before a SQLPassthroughDataSetRanges is built.

Since version 8.0

Property Description

DataSetRangeName

Name of the SQLPassthroughDataSetRange.

DataSetID

ID of the SQLPassthroughDataSet associated with the DataSetRange.

SheetName

When the SQLPassthroughDataSet is used for a cascaded view, the name of the current sheet.

BeforeDataSetRangeSave

Occurs before a SQLPassthroughDataSetRange's changes are saved.

Property Description

DataSetRangeName

The name of the saved SQLPassthroughDataSetRange.

BeforeDataSetRangesBuild

Occurs before all the SQLPassthroughDataSetRanges are built.

BeforeDataSetRangesSave

Occurs before all SQLPassthroughDataSetRanges' changes are saved.

Since version 8.0

BeforeDataTableRangeAddRow

Occurs before a row (or rows) is added to a DataTableRange either by a user adding/inserting a row(s) or when an empty row is automatically added.

Property Description

DataTableRangeName

Name of the DataTableRange.

DataSetRangeName

Name of the SQLPassthroughDataSetRange.

DataSheetRangeName

Name of the data sheet range that contains the row(s).

DataBlockSheetRangeName

If configured for the DataTableRange, the name of the data block sheet range that contains the row(s).

SheetName

The name of the sheet that contains the row(s).

BeforeDataTableRangeDeleteRow

Occurs before a row (or rows) is deleted from a DataTableRange.

Property Description

DataTableRangeName

Name of the DataTableRange.

DataSetRangeName

Name of the SQLPassthroughDataSetRange.

DataSheetRangeName

Name of the data sheet range that contains the row(s).

DataRowAddress

The address of the row(s) within the data sheet range.

DataBlockSheetRangeName

If configured for the DataTableRange, the name of the data block sheet range that contains the row(s).

DataBlockRowAddress

The address of the row(s) within the data block sheet range.

SheetName

The name of the sheet that contains the row(s).

BeforeEmailSend

Occurs before an email is sent.

Since version 8.3

Property Description

ToAddress

The addressee of the email.

CcAddress

The addresses of the email's CC list.

BccAddress

The addresses of the email's BCC list.

FromAddress

The specified from-address.

Subject

The subject of the email message.

MessageBody

The message text of the email.

Attachments

A semicolon delimited list of the names of files attached to the email.

Source

The source of the email send, whether a WorkbookScript Procedure or a tool controller.

Cancel

The send can be canceled using CancelEvent method.

BeforeExcelTemplatePullToClient

Occurs before the Excel template is pulled from the server.

BeforeExportToExcel

Occurs before the view is saved as an Excel file.

BeforeImportFromExcel

Occurs before the view is loaded from an external workbook.

Property Description

WorkbookName

The name of the imported workbook, including the extension.

BeforeImportWorksheet

Occurs before a worksheet is loaded from an external workbook.

Property Description

SheetName

The name of the imported worksheet.

WorkbookName

The name of the imported workbook, including the extension.

BeforeInitializeUI

Occurs before the view's UI is initialized.

BeforeOpenInExcel

Occurs before the workbook is opened in Excel.

BeforeRefresh

Occurs immediately after the Refresh view button is clicked and the view is covered.

BeforeRefreshExecute

Occurs immediately after the Refresh view button is clicked, and before the view is covered.

BeforeSaveAsExcel

Occurs before the workbook is saved as Excel.

BeforeSaveAsPdf

Occurs before a view's grid data is saved as a PDF.

BeforeSelectorListItemsResolved

Occurs before selector list items are resolved.

Property Description

SelectorID

The ID of the selector.

BeforeWorkbookClose

Occurs before the workbook is closed.

BeforeWorkbookOpen

Occurs before the workbook is opened.

CellDoubleClicked

Occurs when a cell is double-clicked.

Property Description

Row

Zero-based row index of the clicked cell.

Column

Zero-based column index of the clicked cell.

RowHeader

A boolean (True or False) that indicates whether the row header was clicked.

ColumnHeader

A boolean (True or False) that indicates whether the column header was clicked.

ShiftKeyDown

A boolean (True or False) that indicates whether the shift key is down.

IsRightButton

A boolean that indicates whether the button clicked is the right (True) or left (False) button.

ChartControlDataDoubleClicked

Occurs when a chart control's data is double-clicked.

Property Description

ChartName

The name of the chart.

Row

Zero-based row index of the clicked data row.

Column

Zero-based column index of the clicked data column.

RowLabel

Text label associated with the clicked data row.

ColumnLabel

Text label associated with the clicked data column.

DataValue

The clicked data value.

IsRightButton

A boolean that indicates whether the button clicked is the right (True) or left (False) button.

ClipboardCopied

Occurs after a clipboard copy operation.

Since version 8.0

Property Description

ClipboardAddress

The address of the range that was copied.

ClipboardCopying

Occurs before a clipboard copy operation.

Since version 8.0

Property Description

ClipboardAddress

The address of the range being copied.

ClipboardCut

Occurs after a clipboard cut operation.

Since version 8.0

Property Description

ClipboardAddress

The address of the range that was cut.

ClipboardCutting

Occurs before a clipboard cut operation.

Since version 8.0

Property Description

ClipboardAddress

The address of the range being cut.

ClipboardPasted

Occurs after a paste.

Property Description

ClipboardPastedAddress

The address of the range that was pasted to.

PasteOption

The paste option, which is one of the following: All, Values, Formats, Formulas, AllExceptBorders, FormulasAndNumberFormats, ValuesAndNumberFormats, Comments, ColumnWidths, Validation

ClipboardPasting

Occurs before a paste.

Property Description

ClipboardPastingAddress

The address of the range being pasted to.

PasteOption

The paste option, which is one of the following: All, Values, Formats, Formulas, AllExceptBorders, FormulasAndNumberFormats, ValuesAndNumberFormats, Comments, ColumnWidths, Validation

CommentExceptionOccurred

Occurs when there is an exception while storing or retrieving comments.

Since version 8.0

Property Description

ExceptionMessage

The text describing the exception.

Deactivated

Occurs when the view is deactivated.

EditCellChanged

Occurs after a cell's content has changed.

Property Description

Row

Zero-based row index of the edited cell.

Column

Zero-based column index of the edited cell.

CellAddress

The A1 reference style address of the edited cell.

SheetIndex

Zero-based index of the sheet that contains the edited cell.

SheetName

Name of the sheet that contains the edited cell.

EditCellChanging

Occurs before cell contents change.

Property Description

Row

Zero-based row index of the edited cell.

Column

Zero-based column index of the edited cell.

EditString

The string entered into the cell.

SheetIndex

Zero-based index of the sheet that contains the edited cell.

SheetName

Name of the sheet that contains the edited cell.

FollowHyperlink

Occurs when a hyperlink is clicked.

Property Description

Address

For a hyperlink that represents a web address, email, or existing file, the Address is the address of the hyperlink.

EmailSubject

For a hyperlink that represents an email, the subject of the email.

RangeAddress

The address of the cell or range that the hyperlink is attached to.

SubAddress

For a hyperlink that represents an existing file or a range within the same workbook, the SubAddress is the bookmark in the linked file or the address within the same workbook, such as "Sheet1!A1".

ListDataValidationCellChanged

Occurs after a cell that has list style data validation is changed. Any change to the cell, including the value, format, etc., raises the event.

Property Description

Row

Zero-based row index of the edited cell.

Column

Zero-based column index of the edited cell.

CellAddress

The A1 reference style address of the edited cell.

SheetIndex

Zero-based index of the sheet that contains the edited cell.

SheetName

Name of the sheet that contains the edited cell.

RangeChanged

Occurs after a change to one or more cells in a range has been applied.

Property Description

RangeAddress

Address of the changed range.

RangeSelectionChanged

Occurs after the selection cells on the sheet has changed.

RangeSelectionCleared

Occurs when the user has cleared the selected cells.

RangeSelectionClearing

Occurs when the user clears the selected cells.

RequestGridContextMenuID

Occurs when the user right clicks a cell and before the context menu is displayed.

Property Description

Row

Zero-based row index of the clicked cell.

Column

Zero-based column index of the clicked cell.

CellAddress

The A1 reference style address of the clicked cell.

SheetIndex

Zero-based index of the sheet that contains the clicked cell.

SheetName

Name of the sheet that contains the clicked cell.

ContextMenuID

Key of the popup menu tool used as the context menu.

RequestSheetContextMenuID

Occurs when the user right clicks in the sheet tab area of a worksheet or anywhere on a chart sheet and before the context menu is displayed.

Property Description

SheetIndex

Zero-based index of the active sheet.

SheetName

Name of the active sheet.

ContextMenuID

Key of the popup menu tool used as the context menu.

SQLExceptionOccurred

Occurs when an exception occurs on the server during a SQL operation.

Property Description

ErrorCode

Exception error code.

Message

Exception message, which is typically the message returned by the server/JDBC driver/database.

Details

Exception details, which provides a descriptive context of the exception on the client, along with the error message.

ServerStackTrace

The string representation of the frames on the call stack of the server at the time the exception was thrown.

ClientStackTrace

The string representation of the frames on the call stack of the client at the time the exception was thrown.

SelectorSelectionChanged

Occurs when the selected value(s) for any of the view's selectors change(s).

Property Description

SelectorID

The ID of the selector.

Shown

Occurs when the view is initially shown.

ToolClicked

Occurs when a tool is clicked.

Since version 8.3

Property Description

ToolKey

The tool's key.

ToolCaption

The tool's caption.

ToolValueChanged

Occurs when a tool's value changes. Tools such as ComboBox, ColorPicker, StateButton, and TextBox have values.

Since version 8.3

Property Description

ToolKey

The tool's key.

ToolCaption

The tool's caption.

ToolValue

The new value of the tool.