Folder
A folder provides a hierarchical structure of the object model for organizing documents. Folders can contain other folders or documents.
public class CdmFolderDefinition extends CdmObjectDefinitionBase, CdmContainerDefinition
CdmFolderDefinition extends CdmObjectDefinition, CdmContainerDefinition in Python.
CdmFolderDefinition extends CdmObjectDefinitionBase in TypeScript.
Constructors
| Name | Description |
|---|---|
| CdmFolderDefinition(CdmCorpusContext, string) ctx: The corpus context. name: The folder's name. |
Initializes a new instance of the CdmFolderDefinition class. |
Properties
| Name | Type | Description |
|---|---|---|
| AtCorpusPath | string | The corpus path of the folder. |
| ChildFolders | CdmFolderCollection | The direct children of the folder. |
| Documents | CdmDocumentCollection | The child documents of the folder. |
| FolderPath | string (read-only) | The folder path starting from the root. |
| Name | string | The name of the folder. |
| Namespace | string (read-only) | The root namespace of the folder. |
Methods
| Name | Description | Return Type |
|---|---|---|
| FetchObjectDefinition<T>(ResolveOptions) | See CdmObject.FetchObjectDefinition<T>(...). | T |
| GetName() | See CdmObjectDefinition.GetName(). | string |
| IsDerivedFrom(string, ResolveOptions) | See CdmObject.IsDerivedFrom(...). | bool |
| Copy(ResolveOptions, CdmObject) | See CdmObject.Copy(...). | CdmObject |
| Validate() | See CdmObject.Validate(). | bool |