Namespace: Consultingwerk.Windows.Framework.System
Class 
SmartCommentControl Copy to Clipboard
Parent classes:
Progress.Windows.UserControl
Consultingwerk.SmartComponents.Base.SmartUserControl
Consultingwerk.Windows.Framework.System.SmartCommentControl

Inherits: Consultingwerk.SmartComponents.Base.SmartUserControl
Implements: IHasDesignerVerbs


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
AddComment () Starts a new comment
AfterRetrieveDataHandler (Object, EventArgs) Event handler for the AfterRetrieveData event of the comment's Business Entity Adapter
BeforeRetrieveDataHandler (Object, CancelEventArgs) Event handler for the BeforeRetrieveData event of the comment's Business Entity Adapter
ClearEditor () Clears the editor
DeleteComment () Deletes the current comment
InitializeComponent ()
LoadComment (character) Loads a comment into the editor
OnLoad (EventArgs) Raises the Load event
ParentFormClosedHandler (Object, FormClosedEventArgs) Event handler for the FormClosed event of the parent Form
LOGICAL PromptSaveChanges () Asks the user to save the unsaved changes of the current comment
QueryClosedHandler (Object, EventArgs) Event handler for the QueryClosed event of the smartBusinessEntityAdapter1 instance
RefreshParentRecord () Refreshes the current record of the SmartDataSource
SaveComment () Saves the current comment
CHARACTER SelectedCommentRoleGuid () Returns the comment role selected in the toolbar
LOGICAL SelectListViewItem (character) Selects the item of a comment in the list view
SetDirty () Marks the current comment as modified
SetToolImage (UltraToolbarsManager, character, character) Assigns the image of a toolbar tool from the IImageProvider service
smartRichTextEditorControl1_ValueChanged (Object, EventArgs) Event handler for the ValueChanged event of the smartRichTextEditorControl1
ultraListView1_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs) Event handler for the ItemSelectionChanged event of the ultraListView1
ultraTextEditor1_TextChanged (Object, EventArgs) Event handler for the TextChanged event of the ultraTextEditor1
ultraToolbarsManager1_ToolClick (Object, ToolClickEventArgs) Event handler for the ToolClick event of the ultraToolbarsManager1 (comment toolbar above the list)
ultraToolbarsManager1_ToolValueChanged (Object, ToolEventArgs) Event handler for the ToolValueChanged event of the ultraToolbarsManager1 (comment toolbar above the list)
UndoChanges () Reverts the unsaved changes of the current comment
UpdateToolbarState () Enables and disables the toolbar tools and the editor based on the current state

Top Constructor Summary
Options Name Purpose
SmartCommentControl () Constructor for the SmartCommentControl class

Top Property Summary
Options Name Purpose
Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource
Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource


Method Detail
Top

AddComment ()
Purpose: Starts a new comment
Notes: Proposes the title from the comment role and the current date
and time. The comment is stored when the user saves it

Top

AfterRetrieveDataHandler (Object, EventArgs)
Purpose: Event handler for the AfterRetrieveData event of the comment's
Business Entity Adapter
Notes: Populates the comment list and reselects the current comment.
While a comment is saved, only the list is refreshed - the
editor is reloaded by SaveComment afterwards

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

BeforeRetrieveDataHandler (Object, CancelEventArgs)
Purpose: Event handler for the BeforeRetrieveData event of the comment's
Business Entity Adapter
Notes: Asks the user to save unsaved changes before the comments of
another record are retrieved. The nested retrieve during a
save (reposition after UpdateRow) does not prompt

Parameters:
sender System.Object
The reference to the object that raised the event
e System.ComponentModel.CancelEventArgs
The CancelEventArgs with the data for this event
Top

ClearEditor ()
Purpose: Clears the editor
Notes: No comment is loaded afterwards

Top

DeleteComment ()
Purpose: Deletes the current comment
Notes: Asks the user for confirmation

Top

InitializeComponent ()

Top

LoadComment (character)
Purpose: Loads a comment into the editor
Notes: Fetches the RTF text through the Dataset Controller

Parameters:
pcAttachmentGuid CHARACTER
The AttachmentGUID of the comment
Top

OnLoad (EventArgs)
Purpose: Raises the Load event
Notes:

Parameters:
e System.EventArgs
The System.EventArgs with the data for this event
Top

ParentFormClosedHandler (Object, FormClosedEventArgs)
Purpose: Event handler for the FormClosed event of the parent Form
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.Windows.Forms.FormClosedEventArgs
The FormClosedEventArgs with the data for this event
Top

LOGICAL PromptSaveChanges ()
Purpose: Asks the user to save the unsaved changes of the current comment
Notes: Saves the comment when the user confirms, discards the changes
otherwise

Returns LOGICAL
Logical value indicating if the changes have been saved or discarded, false when saving failed
Top

QueryClosedHandler (Object, EventArgs)
Purpose: Event handler for the QueryClosed event of the smartBusinessEntityAdapter1
instance
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

RefreshParentRecord ()
Purpose: Refreshes the current record of the SmartDataSource
Notes: Re-evaluates the SmartComments flag of the parent record after a
comment has been added or deleted

Top

SaveComment ()
Purpose: Saves the current comment
Notes: Creates the SmartAttachment record for a new comment, updates
the record of an existing comment. The nested retrieve of the
adapter during the save neither prompts nor clears the editor
(lSaving), the comment is reloaded from the list afterwards

Top

CHARACTER SelectedCommentRoleGuid ()
Purpose: Returns the comment role selected in the toolbar
Notes: Returns an empty string when no comment role is selected

Returns CHARACTER
The GUID of the selected comment role
Top

LOGICAL SelectListViewItem (character)
Purpose: Selects the item of a comment in the list view
Notes:

Parameters:
pcAttachmentGuid CHARACTER
The AttachmentGUID of the comment
Returns LOGICAL
Logical value indicating if the comment is contained in the list view
Top

SetDirty ()
Purpose: Marks the current comment as modified
Notes: Ignored while a comment is loaded into the editor

Top

SetToolImage (UltraToolbarsManager, character, character)
Purpose: Assigns the image of a toolbar tool from the IImageProvider service
Notes:

Parameters:
poToolbarsManager Infragistics.Win.UltraWinToolbars.UltraToolbarsManager
The UltraToolbarsManager owning the tool
pcToolKey CHARACTER
The key of the tool
pcImageKey CHARACTER
The key of the image
Top

smartRichTextEditorControl1_ValueChanged (Object, EventArgs)
Purpose: Event handler for the ValueChanged event of the smartRichTextEditorControl1
Notes: Marks the comment as modified

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

ultraListView1_ItemSelectionChanged (Object, ItemSelectionChangedEventArgs)
Purpose: Event handler for the ItemSelectionChanged event of the ultraListView1
Notes: Loads the selected comment into the editor

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinListView.ItemSelectionChangedEventArgs
The ItemSelectionChangedEventArgs with the data for this event
Top

ultraTextEditor1_TextChanged (Object, EventArgs)
Purpose: Event handler for the TextChanged event of the ultraTextEditor1
Notes: Marks the comment as modified

Parameters:
sender System.Object
The reference to the object that raised the event
e System.EventArgs
The System.EventArgs with the data for this event
Top

ultraToolbarsManager1_ToolClick (Object, ToolClickEventArgs)
Purpose: Event handler for the ToolClick event of the ultraToolbarsManager1
(comment toolbar above the list)
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinToolbars.ToolClickEventArgs
The ToolClickEventArgs with the data for this event
Top

ultraToolbarsManager1_ToolValueChanged (Object, ToolEventArgs)
Purpose: Event handler for the ToolValueChanged event of the ultraToolbarsManager1
(comment toolbar above the list)
Notes:

Parameters:
sender System.Object
The reference to the object that raised the event
e Infragistics.Win.UltraWinToolbars.ToolEventArgs
The ToolEventArgs with the data for this event
Top

UndoChanges ()
Purpose: Reverts the unsaved changes of the current comment
Notes: A new comment that has not been saved yet is discarded

Top

UpdateToolbarState ()
Purpose: Enables and disables the toolbar tools and the editor based on
the current state
Notes:



Constructor Detail
Top

SmartCommentControl ()
Purpose: Constructor for the SmartCommentControl class
Notes:



Property Detail
Top

Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource LinkDataSource

Returns Consultingwerk.SmartComponents.Interfaces.Design.IDesignDataSource
Top

Consultingwerk.SmartComponents.Interfaces.ISmartDataSource SmartDataSource

Returns Consultingwerk.SmartComponents.Interfaces.ISmartDataSource


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       19.09.2026 10:23:13