SftDirectory 2.5

SftDirectory.UserContents Event

Softel vdm, Inc.

A file/folder is added and application-specific contents can be added.

Syntax       

VB.NET

Private Sub object_UserContents(ByVal sender As Object, ByVal e As EventArgumentType) Handles object.UserContents

VB

Private Sub object_UserContents(Folder As SftDirectoryFolder, ByVal Contents As SftDirectoryContentsConstants, UserString As String)

C#.NET

void object_UserContents(object sender, EventArgumentType e);

VC++

void OnUserContentsobject(ISftDirectoryFolder* Folder, enum SftDirectoryContentsConstants Contents, _bstr_t* UserString);

C

HRESULT OnUserContentsobject(ISftDirectoryFolder* Folder, enum SftDirectoryContentsConstants Contents, BSTR* UserString);

Delphi

procedure objectUserContents(Sender: TObject; Folder : ISftDirectoryFolder; Contents : TOleEnum; var UserString : WideString);

object

A SftDirectory object.

Folder

Describes the file/folder being added for which application-specific contents can be added.

Contents

Defines the column contents for which application-specific contents can be added.

Contents

Value

Description

contentsSftDirectoryUser1

51

User defined 1

contentsSftDirectoryUser2

52

User defined 2

contentsSftDirectoryUser3

53

User defined 3

contentsSftDirectoryUser4

54

User defined 4

contentsSftDirectoryUser5

55

User defined 5

contentsSftDirectoryUser6

56

User defined 6

contentsSftDirectoryUser7

57

User defined 7

contentsSftDirectoryUser8

58

User defined 8

contentsSftDirectoryUser9

59

User defined 9

UserString

On return, provides a string containing the text added to the file/folder in the column described by Contents.

Comments

The UserContents event occurs when a file/folder is added and application-specific contents can be added.

The SftDirectoryColumn.Contents property determines the type of data displayed and loaded into a column.  If a column contains application-specific data (contentsSftDirectoryUser1 - contentsSftDirectoryUser9), the UserContents event occurs for each file/folder being added and for each column.

The AutoInitialLoad property may need to be set to False so the control does not load its contents immediately.  This may be necessary if user-defined contents are added in certain columns.  The UserContents event may not occur when the control is initially created, due to certain environment restrictions.  For example, in Visual Basic, the UserContents event is not generated until the Form_Load event has occurred.  The control however is created before the Form_Load event occurs, preventing the UserContents events from being handled by the application. This in effect prevents any user-defined contents from being added to the control.  The solution is to set AutoInitialLoad to False and use the control's Reload method in the Form_Load event.  Setting AutoInitialLoad to False isn't absolutely necessary, but it may save processing time as the control contents are only loaded once, in response to the Reload method.


Feedback / comments / error reports for this topic
© 2003, 2008 - Softel vdm, Inc. - www.softelvdm.com