Represents the options for creating a subfolder in the Outlook PST message store. This class serves as a container for configuring specific settings related to the creation of subfolders. More...
Inherits Object.
Public Member Functions | |
bool | get_CreateHierarchy () const |
Gets a value indicating whether to create the hierarchy of parent folders. More... | |
void | set_CreateHierarchy (bool value) |
Sets a value indicating whether to create the hierarchy of parent folders. More... | |
bool | get_AllowNameCaseDifference () const |
Gets a value indicating whether to allow a difference in name casing when comparing folder names. More... | |
void | set_AllowNameCaseDifference (bool value) |
Sets a value indicating whether to allow a difference in name casing when comparing folder names. More... | |
System::String | get_ContainerClass () const |
Gets the container class for the new subfolder. More... | |
void | set_ContainerClass (System::String value) |
Sets the container class for the new subfolder. More... | |
FolderCreationOptions () | |
Initializes a new instance of the FolderCreationOptions class with default values. More... | |
FolderCreationOptions (bool createHierarchy, bool allowNameCaseDifference) | |
Initializes a new instance of the FolderCreationOptions class with the specified parameters. More... | |
FolderCreationOptions (bool createHierarchy, bool allowNameCaseDifference, System::String containerClass) | |
Initializes a new instance of the FolderCreationOptions class with the specified parameters. More... | |
Represents the options for creating a subfolder in the Outlook PST message store. This class serves as a container for configuring specific settings related to the creation of subfolders.
Aspose::Email::Storage::Pst::FolderCreationOptions::FolderCreationOptions | ( | ) |
Initializes a new instance of the FolderCreationOptions class with default values.
Aspose::Email::Storage::Pst::FolderCreationOptions::FolderCreationOptions | ( | bool | createHierarchy, |
bool | allowNameCaseDifference | ||
) |
Initializes a new instance of the FolderCreationOptions class with the specified parameters.
createHierarchy | A value indicating whether to create the hierarchy of parent folders if they don't exist. |
allowNameCaseDifference | A value indicating whether to allow a difference in name casing when comparing folder names. |
Aspose::Email::Storage::Pst::FolderCreationOptions::FolderCreationOptions | ( | bool | createHierarchy, |
bool | allowNameCaseDifference, | ||
System::String | containerClass | ||
) |
Initializes a new instance of the FolderCreationOptions class with the specified parameters.
createHierarchy | A value indicating whether to create the hierarchy of parent folders if they don't exist. |
allowNameCaseDifference | A value indicating whether to allow a difference in name casing when comparing folder names. |
containerClass | The container class for the new subfolder. |
bool Aspose::Email::Storage::Pst::FolderCreationOptions::get_AllowNameCaseDifference | ( | ) | const |
Gets a value indicating whether to allow a difference in name casing when comparing folder names.
true
if a difference in name casing should be allowed when comparing folder names; otherwise, false
. The default value is false
.
If a folder with the same name already exists when adding a new folder and AllowNameCaseDifference is set to true
, the folder names will be treated as different even if the casing differs. In this case, no exception will be thrown, and the folder will be added. When AllowNameCaseDifference is set to false
, the comparison will be case-insensitive, and the folder creation operation will consider folders with the same name but different casing as duplicates, throwing an InvalidOperationException to indicate that a folder with the specified name already exists.
System::String Aspose::Email::Storage::Pst::FolderCreationOptions::get_ContainerClass | ( | ) | const |
Gets the container class for the new subfolder.
The container class represents the message class of the new subfolder. The default value is "IPF.Note".
bool Aspose::Email::Storage::Pst::FolderCreationOptions::get_CreateHierarchy | ( | ) | const |
Gets a value indicating whether to create the hierarchy of parent folders.
true
if the hierarchy of parent folders should be created. In this case, the name of the subfolder to be created is considered as path; false
if only the subfolder with specified name should be created. The default value is false
.
When specifying the subfolder path, use the backslash () as the separator between folder names. For example, "parent1\parent2\subfolder".
void Aspose::Email::Storage::Pst::FolderCreationOptions::set_AllowNameCaseDifference | ( | bool | value | ) |
Sets a value indicating whether to allow a difference in name casing when comparing folder names.
true
if a difference in name casing should be allowed when comparing folder names; otherwise, false
. The default value is false
.
If a folder with the same name already exists when adding a new folder and AllowNameCaseDifference is set to true
, the folder names will be treated as different even if the casing differs. In this case, no exception will be thrown, and the folder will be added. When AllowNameCaseDifference is set to false
, the comparison will be case-insensitive, and the folder creation operation will consider folders with the same name but different casing as duplicates, throwing an InvalidOperationException to indicate that a folder with the specified name already exists.
void Aspose::Email::Storage::Pst::FolderCreationOptions::set_ContainerClass | ( | System::String | value | ) |
Sets the container class for the new subfolder.
The container class represents the message class of the new subfolder. The default value is "IPF.Note".
void Aspose::Email::Storage::Pst::FolderCreationOptions::set_CreateHierarchy | ( | bool | value | ) |
Sets a value indicating whether to create the hierarchy of parent folders.
true
if the hierarchy of parent folders should be created. In this case, the name of the subfolder to be created is considered as path; false
if only the subfolder with specified name should be created. The default value is false
.
When specifying the subfolder path, use the backslash () as the separator between folder names. For example, "parent1\parent2\subfolder".