Namespace: Consultingwerk.SmartComponents.Interfaces
Interface 
ISmartTableIOTarget Copy to Clipboard
Parent classes:
Inherits: Progress.Lang.Object
Implemented by: Consultingwerk.BusinessEntityDesigner.UI.BusinessEntityViewerControl, Consultingwerk.BusinessEntityDesigner.UI.DataRelationViewerControl, Consultingwerk.BusinessEntityDesigner.UI.FieldViewerControl, Consultingwerk.BusinessEntityDesigner.UI.IndexViewerControl, Consultingwerk.BusinessEntityDesigner.UI.MemberTableViewerControl, Consultingwerk.SmartComponents.Base.SmartViewerControl, Consultingwerk.SmartComponents.Implementation.SmartDynamicUpdatableBrowser, Consultingwerk.SmartComponents.Implementation.SmartDynamicViewer, Consultingwerk.SmartComponents.Implementation.SmartUpdatableBrowser, Consultingwerk.Windows.Framework.Authentication.SmartUserViewer, Consultingwerk.Windows.Framework.Authorization.SmartFieldSecurityItemViewerControl, Consultingwerk.Windows.Framework.Authorization.SmartGroupViewer, Consultingwerk.Windows.Framework.Authorization.SmartSecurityAssignmentViewerControl, Consultingwerk.Windows.Framework.Authorization.SmartSecurityRealmViewerControl, Consultingwerk.Windows.Framework.Authorization.SmartSecurityTokenViewerControl, Consultingwerk.Windows.Framework.Authorization.SmartToolbarSecurityItemViewerControl, Consultingwerk.Windows.Framework.Menu.SmartFunctionViewer, Consultingwerk.Windows.Framework.Menu.SmartMenuStyleViewerControl, Consultingwerk.Windows.Framework.Menu.SmartMenuViewer, Consultingwerk.Windows.Framework.Menu.SmartModuleViewer, Consultingwerk.Windows.Framework.Menu.SmartProductViewerControl, Consultingwerk.Windows.Framework.Repository.Class.SmartAttributeGroupViewerControl, Consultingwerk.Windows.Framework.Repository.Class.SmartAttributeViewerControl, Consultingwerk.Windows.Framework.Repository.Class.SmartClassTypeViewerControl, Consultingwerk.Windows.Framework.Repository.Class.SmartLinkTypeViewerControl, Consultingwerk.Windows.Framework.Repository.Class.SmartObjectTypeViewerControl, Consultingwerk.Windows.Framework.Repository.Class.SmartSupportedLinkViewerControl, Consultingwerk.Windows.Framework.Repository.Customization.SmartCustomizationResultViewerControl, Consultingwerk.Windows.Framework.Repository.Customization.SmartCustomizationTypeViewerControl, Consultingwerk.Windows.Framework.Repository.Customization.SmartCustomizationViewerControl, Consultingwerk.Windows.Framework.Scheduler.SmartSchedulerJobPlanViewerControl, Consultingwerk.Windows.Framework.Scheduler.SmartSchedulerJobStatusViewerControl, Consultingwerk.Windows.Framework.Scheduler.SmartSchedulerJobViewerControl, Consultingwerk.Windows.Framework.System.SmartAttachmentRoleViewerControl, Consultingwerk.Windows.Framework.System.SmartBusinessEntityTableViewerControl, Consultingwerk.Windows.Framework.System.SmartBusinessEntityViewerControl, Consultingwerk.Windows.Framework.System.SmartCommentRoleViewerControl, Consultingwerk.Windows.Framework.System.SmartKeyFieldAssignmentTypeViewerControl, Consultingwerk.Windows.Framework.System.SmartLanguageViewer, Consultingwerk.Windows.Framework.System.SmartLoginCompanyViewer, Consultingwerk.Windows.Framework.System.SmartMessageViewerControl, Consultingwerk.Windows.Framework.System.SmartRelationViewerControl, Consultingwerk.Windows.Framework.System.SmartTableViewerControl, Consultingwerk.Windows.Framework.System.SmartTranslationViewerControl, Consultingwerk.Windows.Framework.System.SmartUiTranslationViewerControl, Consultingwerk.Windows.Framework.System.SmartValueListViewerControl

File:ISmartTableIOTarget
Purpose:Interface declaring the members of a TableIO target
(viewer / browser) component
Author(s):Mike Fechner / Consultingwerk Ltd.
Created:Mon Jan 19 09:12:42 CET 2009



Top Method Summary
Options Name Purpose
+ AddRecord () Add a new record to the SmartDataSource. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the AddRecord Tool.
+ CancelUpdate () Reverts the changes to the current record This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the corresponding Tool.
+ CopyRecord () Copy the current record to a new one. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the corresponding Tool.
+ DeleteRecord () Delete the current record. The Method DeleteRow of the SmartDataSource is called to Handle this Task. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the corresponding Tool.
+ DisableFields () Disable all enabled controls of the SmartViewerControl. This Method is called from inside the SmartViewerControl.
+ EnableFields (character) Enables controls of the SmartTableIOTarget This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the Tools for Add or Edit Data.
+ HandleValidationError (Error) Handles an error raised by validation routines
+ SaveChanges () Saves the current changes to the database. This Method is called by the Toolbar Classes SmartToolbarController or SmartToolStripContainer by pressing the corresponding Tool.

Top Event Summary
Options Name Purpose
+ SmartTableIOStateChanged (Object, SmartTableIOStateChangedEventArgs) Event fired whenever the SmartTableIOState property has changed

Top Property Summary
Options Name Purpose
+ CHARACTER SecurityKey /*- Purpose: Gets and sets the Toolbar Security Key Notes: */
+ Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource SmartTableIOSource Get and Set the current SmartTableIOSource of the SmartViewerControl. This Property is set by the developer when initializing a Control implementing the Interface ISmartDataTarget.
+ CHARACTER SmartTableIOState The SmartTableIOState property reflects the operationmode of the SmartViewerControl. Value changes of this Property are only made in the Class SmartViewerControl.


Method Detail
Top

PUBLIC AddRecord ()

Purpose: Add a new record to the SmartDataSource.
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the AddRecord Tool.
Notes:

Top

PUBLIC CancelUpdate ()

Purpose: Reverts the changes to the current record
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the corresponding Tool.
Notes:

Top

PUBLIC CopyRecord ()

Purpose: Copy the current record to a new one.
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the corresponding Tool.
Notes:

Top

PUBLIC DeleteRecord ()

Purpose: Delete the current record. The Method DeleteRow of the
SmartDataSource is called to Handle this Task.
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the corresponding Tool.
Notes:

Top

PUBLIC DisableFields ()

Purpose: Disable all enabled controls of the SmartViewerControl.
This Method is called from inside the SmartViewerControl.
Notes:

Top

PUBLIC EnableFields (character)

Purpose: Enables controls of the SmartTableIOTarget
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the Tools for Add or Edit Data.
Notes:

Parameters:
pcFields CHARACTER
The EnableFieldsEnum value indicating if the fields are enabled for Add or Update
Top

PUBLIC HandleValidationError (Error)

Purpose: Handles an error raised by validation routines
Notes: Typically displays the Error message and focusses the field that
caused the error

Parameters:
poError Progress.Lang.Error
The reference to the validation error instance
Top

PUBLIC SaveChanges ()

Purpose: Saves the current changes to the database.
This Method is called by the Toolbar Classes SmartToolbarController
or SmartToolStripContainer by pressing the corresponding Tool.
Notes:



Event Detail
Top

PUBLIC SmartTableIOStateChanged (Object, SmartTableIOStateChangedEventArgs)

Purpose: Event fired whenever the SmartTableIOState property has changed
Notes:

Parameters:
sender System.Object
The object that raised the event
e Consultingwerk.SmartComponents.Base.SmartTableIOStateChangedEventArgs
The SmartTableIOStateChangedEventArgs with the data for this event


Property Detail
Top

PUBLIC CHARACTER SecurityKey

Purpose: Gets and sets the Toolbar Security Key
Notes:

Returns CHARACTER
Top

PUBLIC Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource SmartTableIOSource

Purpose: Get and Set the current SmartTableIOSource of the SmartViewerControl.
This Property is set by the developer when initializing a Control
implementing the Interface ISmartDataTarget.
Notes: Cannot be changed while the SmartViewerControl is in ModifyingData mode.

Returns Consultingwerk.SmartComponents.Interfaces.ISmartTableIOSource
Top

PUBLIC CHARACTER SmartTableIOState

Purpose: The SmartTableIOState property reflects the operationmode of the
SmartViewerControl.
Value changes of this Property are only made in the Class
SmartViewerControl.
Notes: Possible values (TableIOStateEnum):
- AddCopyAllowed
- FieldsDisabled
- FieldsEnabled
- ModifyingData
- NoDataSource

Returns CHARACTER


©2006-2016 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       26.08.2016 08:33:21