SftDirectory 2.5

SftDirectory.Column Property

Softel vdm, Inc.

Returns a SftDirectoryColumn object for a given contents value.

Syntax       

Get

VB.NET

refColumnObj = object.get_Column(ByVal ColumnContents As SftDirectoryContentsConstants)  As SftDirectoryColumn

VB

Set refColumnObj = object.Column(ByVal ColumnContents As SftDirectoryContentsConstants)  As SftDirectoryColumn

C#.NET

SftDirectoryColumn refColumnObj = object.get_Column(SftDirectoryContentsConstants ColumnContents);

VC++

ISftDirectoryColumn* refColumnObj = object->Column[enum SftDirectoryContentsConstants ColumnContents];
ISftDirectoryColumn* refColumnObj = object->GetColumn(enum SftDirectoryContentsConstants ColumnContents);

C

HRESULT object->get_Column(enum SftDirectoryContentsConstants ColumnContents, ISftDirectoryColumn** refColumnObj);

Delphi

refColumnObj := object.Column[ColumnContents : TOleEnum]  : ISftDirectoryColumn;

object

A SftDirectory object.

ColumnContents

Defines the column contents for which a SftDirectoryColumn object should be returned.

ColumnContents

Value

Description

contentsSftDirectoryName

0

Name - Simple folder name.

contentsSftDirectorySize

1

Size - The file size, if available.

contentsSftDirectoryType

2

Type - The type of the folder as defined by the Windows Shell, if available.

contentsSftDirectoryDateMod

3

Date Modified - The date the folder was last modified, if available.

contentsSftDirectoryDateCre

4

Date Created - The date the folder was last modified, if available.

contentsSftDirectoryDateAcc

5

Date Accessed - The date the folder was last accessed, if available.

contentsSftDirectoryAttributes

6

Attributes - The attributes of the folder:  'A' - Folders ready to be archived, 'H' - hidden, 'C' - compressed, 'E' - encrypted folders.

contentsSftDirectoryUser1

51

User defined 1 - User-defined contents are added while the control's contents are added using the UserContents event.  If user-defined contents are added, the AutoInitialLoad property may need to be set to False.  

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.

refColumnObj

Returns a SftDirectoryColumn object for a given contents value.

Comments

The Column property returns a SftDirectoryColumn object for a given contents value.

Columns are managed by their contents value ColumnContents, rather than by their position.  The column object SftDirectoryColumn is returned for the column containing the desired contents.  If two columns have the same contents, the first column is returned.  It is not possible to return the second column with identical contents.

The ColumnEntry property can be used to retrieve SftDirectoryColumn objects using the zero-based column number.

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