AMFolder object

You are here: COM API reference > Server objects > AMFolder object

AMFolder object

This object represents an Explorer view folder in the vault.

Members (AMFolder)
Name	Description
AccessRights property	Reserved. See “About reserved objects, methods, and properties.”
Archive property	Reserved. See “About reserved objects, methods, and properties.”
CanDelete property	True if it is possible to delete the folder.
Copy method	Copies the folder and its content to the target folder (does not cause any events to occur).
Created property	The date/time the folder was created.
CreatedBy property	The name of the person who created the folder.
DefaultDocumentAccessRights property	Reserved. See “About reserved objects, methods, and properties.”
DefaultRedliningAccessRights property	Reserved. See “About reserved objects, methods, and properties.”
DeletedFSObjects property	Reserved. See “About reserved objects, methods, and properties.”
DeleteFSObjectWithID method	Deletes a folder or document from this folder.
DisplayName property	Folder name.
Elements property	Collection of documents and folders in this folder. See Remarks.
FileType property	Not used.
FSObjectWithDisplayName property	The child folder or document object having the given file/folder name.
GetDefaultDocumentSecurityData method	Reserved. See “About reserved objects, methods, and properties.”
GetDefaultRedliningSecurityData method	Reserved. See “About reserved objects, methods, and properties.”
GetSecurityData method	Reserved. See “About reserved objects, methods, and properties.”
HasChildWithDisplayName property	True if the folder contains an item with this file/folder name.
IDproperty	Object ID.
ImportedFrom property	Reserved. See “About reserved objects, methods, and properties.”
IsFolder property	True.
Modified property	Not used.
ModifiedBy property	Not used.
Move method	Moves the folder and its content to an other folder (does not cause any events to occur).
Name property	Internal name.
NewDocument method	Creates a new document in the folder. Using this method will bypass any customization. Please use the AMFolderUI object.
NewFolder method	Creates a new subfolder.
ParentFolder property	The containing folder.
Path property	The relative path from the root of the vault.
Repository property	Reference to the current transaction.
SetDefaultDocumentSecurityData method	Reserved. See “About reserved objects, methods, and properties.”
SetDefaultRedliningSecurityData method	Reserved. See “About reserved objects, methods, and properties.”
SetSecurityData method	Reserved. See “About reserved objects, methods, and properties.”
Size property	Not used.
UnDeleteFSObject method	Reserved. See “About reserved objects, methods, and properties.”

Members (IAMFolder2)
Name	Description
NewFolderWithName method	Reserved. See “About reserved objects, methods, and properties.

Members (IAMFolder3)
Name	Description
GetDocumentCount method	Returns the number of documents in the folder. When the argument is <>0, the documents will be counted recursively. This can be used to give reliable progress information for batch operations.

Members (IAMFolder4)
Name	Description
GetChildPossibleNames method	Returns a safe array of possible child names if the folder is a Field-Path Relation branch. S_FALSE and VT_EMPTY otherwise

Members (IAMFolder5)
Name	Description
IsConfigurable property	True when the object is of type AMConfigurableFolder
ConfigurableFolder property	The configurable folder of this folder
FolderTypeName property	The name of the folder type
FolderTypeDisplayName property	The display name of the folder type
GlobalID property	Global ID
CreateGlobalID method	Creates Global ID (equal to folder ID)

Remarks

Elements

This property returns a collection of the elements (document and folder) in the folder.

The Elements argument can be used to retrieve only documents (EFF_DOCSONLY) or only folders (EFF_FOLDERSONLY) or both (EFF_ALL).

Dim docs As Long
docs = folder.Elements( EFF_DOCSONLY ).Count
MsgBox "Folder " & folder.DisplayName & " contains " & docs & " document(s)"

Other Interfaces

IAMFSObject interface

IPersistAMObject

IAMVersionable interface