SftDirectory 2.5

SftDirectoryFolder.GetText Method

Softel vdm, Inc.

Retrieves the file/folder's text.

Syntax       

VB.NET

String = object.GetText(ByVal ColumnContents As SftDirectoryContentsConstants)  As String

VB

String = object.GetText(ByVal ColumnContents As SftDirectoryContentsConstants)  As String

C#.NET

string String = object.GetText(SftDirectoryContentsConstants ColumnContents);

VC++

_bstr_t String = object->GetText(enum SftDirectoryContentsConstants ColumnContents);

C

HRESULT object->raw_GetText(enum SftDirectoryContentsConstants ColumnContents, BSTR* String);

Delphi

String := object.GetText(ColumnContents : TOleEnum)   : WideString;

object

A SftDirectoryFolder object.

ColumnContents

Defines the column contents for which the text 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.  The DateCreated property also returns the date and time the folder was created.

contentsSftDirectoryDateAcc

5

Date Accessed - The date the folder was last accessed, if available.  The DateAccessed property also returns the date and time the folder was last accessed.

contentsSftDirectoryAttributes

6

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

contentsSftDirectoryUser1

51

User defined 1 - User-defined contents are added while the control's contents are added using the UserContents event.

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.

String

Returns the file/folder's text.

Comments

The GetText method retrieves the file/folder's text.

The text can only be retrieved if a column with the specified contents has been defined.


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