|
|
|
SftDirectory.CheckBoxClicked Event |
A checkbox is clicked.
Syntax
VB.NET |
Private Sub object_CheckBoxClicked(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.CheckBoxClicked |
||
VB |
Private Sub object_CheckBoxClicked(Folder As SftDirectoryFolder, ByVal OldValue As SftDirectoryCheckBoxValueConstants, NewValue As SftDirectoryCheckBoxValueConstants) |
||
C#.NET |
void object_CheckBoxClicked(object sender, EventArgumentType e); |
||
VC++ |
void OnCheckBoxClickedobject(ISftDirectoryFolder* Folder, enum SftDirectoryCheckBoxValueConstants OldValue, enum SftDirectoryCheckBoxValueConstants* NewValue); |
||
C |
HRESULT OnCheckBoxClickedobject(ISftDirectoryFolder* Folder, enum SftDirectoryCheckBoxValueConstants OldValue, enum SftDirectoryCheckBoxValueConstants* NewValue); |
||
Delphi |
procedure objectCheckBoxClicked(Sender: TObject; Folder : ISftDirectoryFolder; OldValue : TOleEnum; var NewValue : TOleEnum); |
object
A SftDirectory object.
Folder
Defines the folder whose checkbox is clicked.
OldValue
The current checkbox value (before being clicked).
OldValue |
Value |
Description |
0 |
None - While this is a valid SftDirectoryCheckBoxValueConstants value, it is never passed to the CheckBoxClicked event. |
|
1 |
Not selected - The checkbox option is enabled and not selected. NewValue defaults to checkboxSftDirectoryYes. |
|
2 |
Selected - The checkbox option is enabled and selected. NewValue defaults to checkboxSftDirectoryNo. |
|
3 |
Unknown - The checkbox option is enabled and unknown. |
|
4 |
Not selected, disabled - The checkbox option is disabled and not selected. |
|
5 |
Selected, disabled - The checkbox option is disabled and selected. |
|
6 |
Unknown, disabled - The checkbox option is disabled and unknown. |
NewValue
The new checkbox value to take effect once the CheckBoxClicked event is processed.
NewValue |
Value |
Description |
0 |
None - The checkbox is removed. |
|
1 |
Not selected - The checkbox option is enabled and not selected. |
|
2 |
Selected - The checkbox option is enabled and selected. |
|
3 |
Unknown - The checkbox option is enabled and unknown. |
|
4 |
Not selected, disabled - The checkbox option is disabled and not selected. |
|
5 |
Selected, disabled - The checkbox option is disabled and selected. |
|
6 |
Unknown, disabled - The checkbox option is disabled and unknown. |
Comments
The CheckBoxClicked event occurs when a checkbox is clicked.
An application can override the new checkbox state NewValue using the CheckBoxClicked event.
The checkbox state of a folder does not automatically affect its child folders' or parent folder's checkbox states. If desired, these must be updated explicitly using the SetSubFolderCheckBoxes method or the EvaluateSubFolderCheckBoxes method.
This event is typically implemented to handle checkbox states other than yes/no (checkboxSftDirectoryYes and checkboxSftDirectoryNo). By default, checkbox state checkboxSftDirectoryNo is toggled to checkboxSftDirectoryYes and vice versa. Other checkbox states such as checkboxSftDirectoryUnknown, checkboxSftDirectoryNoDisabled, checkboxSftDirectoryYesDisabled or checkboxSftDirectoryUnknownDisabled are not altered, but can be modified using the CheckBoxClicked event, by supplying a new state NewValue.