BCFolder Class

BCFolder Class

Represents an Explorer view folder in the vault.

Inheritance Hierarchy

SystemObject
  BlueCieloECM.InnoCielo.MeridianDisposableObject
    BlueCieloECM.InnoCielo.Meridian.ServerBCRepositoryObject
      BlueCieloECM.InnoCielo.Meridian.ServerBCFSObject
        BlueCieloECM.InnoCielo.Meridian.ServerBCFolder
          BlueCieloECM.InnoCielo.Meridian.ServerBCProject

Namespace: BlueCieloECM.InnoCielo.Meridian.Server
Assembly: BlueCieloECM.InnoCielo.Meridian (in BlueCieloECM.InnoCielo.Meridian.dll) Version: 4.0.0.0 (4.0.19.0)

Syntax

C++

Copy

public class BCFolder : BCFSObject

Public Class BCFolder
	Inherits BCFSObject

public ref class BCFolder : public BCFSObject

type BCFolder =  
    class
        inherit BCFSObject
    end

The BCFolder type exposes the following members.

Constructors

	Name	Description
	BCFolder	Initializes a new instance of the BCFolder class.

Top

Properties

	Name	Description
	AccessRights	Gets access rights of the folder. (Overrides BCFSObjectAccessRights.)
	Archive	Gets or sets a value indicating whether the object is archive. (Inherited from BCFSObject.)
	CanDelete	Gets a value indicating whether the object can be deleted. (Inherited from BCFSObject.)
	ConfigurableFolder	Obsolete. Gets the configurable folder of the folder.
	Created	Gets the date when the object was created. (Inherited from BCFSObject.)
	CreatedBy	Gets the name of the person who created the object. (Inherited from BCFSObject.)
	DefaultDocumentAccessRights	Gets the default access rights of a document in the folder.
	DefaultRedliningAccessRights	Gets the default access rights of document redlines in the folder.
	DeletedFSObjects	Gets the collection of objects that were deleted.
	Description	Gets or sets the description of the folder.
	DisplayName	Gets or sets the display name of the object. (Inherited from BCFSObject.)
	Enclosure	Gets the enclosure that manages access to dependent objects.
	Extendable	Gets the extended object. (Inherited from BCRepositoryObject.)
	FieldPathLevel	Gets the Field-Path level object controlling the folder, or if the folder is not controlled.
	FileType	Gets or sets the Windows-defined file type of the object. (Inherited from BCFSObject.)
	FolderType	Gets or sets the type of the folder. Returns if the folder is normal (the AMFolder type).
	FolderTypeDisplayName	Gets the display name of a folder type.
	FolderTypeName	Gets the name of a folder type.
	GlobalID	Gets or sets the value that uniquely identifies the folder among all vaults. (Overrides BCFSObjectGlobalID.)
	ID	Gets the value that uniquely identifies the object. (Inherited from BCFSObject.)
	ImportedFrom	Gets or sets the path to the document/folder from which the object was imported. (Inherited from BCFSObject.)
	IsConfigurable	Obsolete. Gets a value indicating whether the folder is a configurable folder.
	IsDisposed	Gets a value indicating whether the object has been disposed of. (Inherited from DisposableObject.)
	IsFolder	Obsolete. Gets a value indicating whether the object is a folder. (Inherited from BCFSObject.)
	IsProject	Obsolete. Gets a value indicating whether the folder is a project.
	Modified	Gets or sets the date when the object was last edited. (Inherited from BCFSObject.)
	ModifiedBy	Gets or sets the name of the person who last edited the object. (Inherited from BCFSObject.)
	Name	Gets the internal name of the object. (Inherited from BCFSObject.)
	ParentFolder	Gets the parent folder of the object. (Inherited from BCFSObject.)
	ParentProject	Gets the parent project of the folder.
	ParentProjectID	Gets the parent project ID of the folder.
	Path	Gets the relative path where the object is located. (Inherited from BCFSObject.)
	Repository	Gets the repository to which the object belongs. (Inherited from BCRepositoryObject.)
	Securable	Gets the secured object. (Inherited from BCRepositoryObject.)
	Size	Gets or sets the file size of the object. (Inherited from BCFSObject.)
	TopmostProject	Gets the topmost parent project of the folder.
	UnderlyingObject	Gets the underlying wrapped object. (Inherited from DisposableObject.)

Top

Methods

	Name	Description
	ConvertToConfigurableFolder	Obsolete. Converts the folder to a configurable folder of the specified type.
	ConvertToProject	Obsolete. Converts the folder to a project of the specified type.
	Copy	Creates a copy of the object. (Inherited from BCFSObject.)
	CreateGlobalID	Generates a new value that uniquely identifies the folder among all vaults. (Overrides BCFSObjectCreateGlobalID.)
	DeleteFSObjectWithID	Deletes a folder or document from this folder.
	Dispose	Releases the underlying wrapped object explicitly. (Inherited from DisposableObject.)
	Elements	Returns the collection of all objects in the folder. The collection is sorted ascending on the DisplayName property value.
	Elements(FSObjectKind)	Returns the collection of objects in the folder. The collection is sorted ascending on the DisplayName property value.
	Elements(FSObjectKind, BCCollectionBaseBCPropertyDef)	Returns the collection of objects in the folder. The collection is sorted ascending on the DisplayName property value.
	Elements(FSObjectKind, IEnumerableString)	Returns a collection of objects in the folder. The collection is sorted ascending on the DisplayName property value.
	Elements(FSObjectKind, BCCollectionBaseBCPropertyDef, SortKind)	Returns the collection of objects in the folder.
	Elements(FSObjectKind, IEnumerableString, PropertyDefFlags)	Returns the collection of objects in the folder. The collection is sorted ascending on the DisplayName property value.
	Elements(FSObjectKind, IEnumerableString, PropertyDefFlags, SortKind)	Returns a collection of objects in the folder.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	FSObjectWithDisplayName	Returns a child folder or document object having the given DisplayName property value.
	GetChildPossibleNames	Returns an array of possible child names if the folder is a Field-Path branch.
	GetCreatableFolderTypes(Boolean)	Returns the collection of folder types that are creatable in the folder.
	GetCreatableFolderTypes(Boolean, Boolean)	Returns the collection of folder types that are creatable in the folder.
	GetCreatableProjects	Returns the collection of project definitions that are creatable inside the folder.
	GetDepthFirstProjects	Returns the collection of unreleased depth-first search projects.
	GetDepthFirstProjects(Boolean)	Returns the collection of depth-first search projects.
	GetDocumentCount	Returns a number of documents in the folder.
	GetFolderCount	Returns a number of sub-folders in the folder.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetSequence	Returns a sequence with the specified name. If the sequence does not exist, creates it. (Inherited from BCRepositoryObject.)
	GetSequenceList	Returns an array of all available sequences. (Inherited from BCRepositoryObject.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	HasChildWithDisplayName	Returns a value indicating whether the folder contains an object with the specified display name.
	LoadProperties	Returns a property collection for a property set with the specified name. (Inherited from BCRepositoryObject.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Move	Moves the object to another folder. (Inherited from BCFSObject.)
	NewConfigurableFolder(BCFolderType)	Obsolete. Creates a new sub-folder in the folder with the specified type.
	NewConfigurableFolder(BCFolderType, String)	Obsolete. Creates a new sub-folder with the specified type and name.
	NewDocument(BCDocumentType)	Creates a new document in the folder.
	NewDocument(BCDocumentType, BCDocumentTemplate)	Creates a new document in the folder.
	NewFolder	Creates a new normal sub-folder in the folder.
	NewFolder(String)	Creates a new normal sub-folder in the folder with the specified name.
	NewFolder(String, BCFolderType)	Creates a new sub-folder in the folder with the specified type and name.
	NewProject(BCProjectDefinition)	Creates a new project sub-folder.
	NewProject(BCProjectDefinition, String)	Creates a new project sub-folder with the specified name.
	OnDispose	The method is called on the Dispose method call. Derived classes should override the method to perform custom disposing. (Inherited from DisposableObject.)
	PurgeFSObject	Purges a given object.
	SaveProperties	Saves a property collection. (Inherited from BCRepositoryObject.)
	ThrowIfDisposed	Throws the ObjectDisposedException exception if the underlying object has been disposed. (Inherited from DisposableObject.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UnDeleteFSObject(BCFSObject)	Undeletes a given object without creating a draft revision.
	UnDeleteFSObject(BCFSObject, Boolean)	Undeletes a given object.

Top

Reference

BlueCieloECM.InnoCielo.Meridian.Server Namespace