Represents a single folder in dotMailer's Document Manager.
More...
|
| DmDocumentFolder | FindChildDocumentFolderById (int folderId, bool searchSubFolders) |
| | Searches for a child folder with the specified folder ID, optionally searching the child folders of each child folder encountered.
|
| |
| int | IndexOfChildFolder (string folderName, bool caseSensitive=false) |
| | Searches for the specified child folder and returns the zero-based index of the first occurrence.
|
| |
| DmDocumentFolder | FindFolder (int folderId) |
| | Finds a folder by id
|
| |
|
| string | ObjectType [get, set] |
| | Returns the type name of the class Used by the serialisation process
|
| |
| bool | IsDirty [get] |
| | Returns true if the object has changed
|
| |
| string | ExternalId [get] |
| | The generated Id that uniquely identifies this record across all dotMailer accounts.
|
| |
| int | AccountId [get, set] |
| | The dotMailer account Id for this document folder.
|
| |
| int | Id [get, set] |
| | The unique ID of this folder within the dotMailer account.
|
| |
| int | ParentId [get, set] |
| | The unique ID of the folder which acts as a parent to this folder.
|
| |
| string | Name [get, set] |
| | The name of the folder.
|
| |
| DmDocumentFolderCollection | ChildFolders [get, set] |
| | A collection of child folders to which this folder acts as a parent folder.
|
| |
| string | UserTag1 [get, set] |
| | User Tag
|
| |
| string | UserTag2 [get, set] |
| | User Tag
|
| |
| string | UserTag3 [get, set] |
| | User Tag
|
| |
| int | AccountId [get] |
| | The DotMailer account Id for this object
|
| |
| string | ExternalId [get] |
| | A key that represents this object, used for synching with external applications
|
| |
| bool | IsDirty [get] |
| | has the data of the object changed
|
| |
Represents a single folder in dotMailer's Document Manager.
| DmDocumentFolder dotMailer.Sdk.Objects.Documents.DmDocumentFolder.FindChildDocumentFolderById |
( |
int |
folderId, |
|
|
bool |
searchSubFolders |
|
) |
| |
Searches for a child folder with the specified folder ID, optionally searching the child folders of each child folder encountered.
- Parameters
-
| folderId | The ID of the folder to find. |
| searchSubFolders | If true then the child folders of each child folder are also searched. |
- Returns
| DmDocumentFolder dotMailer.Sdk.Objects.Documents.DmDocumentFolder.FindFolder |
( |
int |
folderId | ) |
|
Finds a folder by id
- Parameters
-
- Returns
| int dotMailer.Sdk.Objects.Documents.DmDocumentFolder.IndexOfChildFolder |
( |
string |
folderName, |
|
|
bool |
caseSensitive = false |
|
) |
| |
Searches for the specified child folder and returns the zero-based index of the first occurrence.
- Parameters
-
| folderName | The name of the folder to find. |
| caseSensitive | Pass true if the search should be case sensitive. |
- Returns
- The index of the child folder, or -1 if the folder was not found.
| int dotMailer.Sdk.Objects.Documents.DmDocumentFolder.AccountId |
|
getset |
The dotMailer account Id for this document folder.
A collection of child folders to which this folder acts as a parent folder.
| string dotMailer.Sdk.Objects.Documents.DmDocumentFolder.ExternalId |
|
get |
The generated Id that uniquely identifies this record across all dotMailer accounts.
| int dotMailer.Sdk.Objects.Documents.DmDocumentFolder.Id |
|
getset |
The unique ID of this folder within the dotMailer account.
| bool dotMailer.Sdk.Objects.Documents.DmDocumentFolder.IsDirty |
|
get |
Returns true if the object has changed
| string dotMailer.Sdk.Objects.Documents.DmDocumentFolder.Name |
|
getset |
| string dotMailer.Sdk.Objects.Documents.DmDocumentFolder.ObjectType |
|
getset |
Returns the type name of the class Used by the serialisation process
| int dotMailer.Sdk.Objects.Documents.DmDocumentFolder.ParentId |
|
getset |
The unique ID of the folder which acts as a parent to this folder.
| string dotMailer.Sdk.Objects.Documents.DmDocumentFolder.UserTag1 |
|
getset |
| string dotMailer.Sdk.Objects.Documents.DmDocumentFolder.UserTag2 |
|
getset |
| string dotMailer.Sdk.Objects.Documents.DmDocumentFolder.UserTag3 |
|
getset |
Properties inherited from dotMailer.Sdk.Interfaces.IDmObject
1.8.3