CloneFolder Method
- Last UpdatedNov 06, 2025
- 3 minute read
The CloneFolder() method opens the Create Folder dialog to allow the user to create a new folder. An item ID, operation ID, operation description, entity ID, and version ID can be passed in as suggestions for the user, but the user can change any or all of these.
'Declaration
Public Shared Function CloneFolder( _
ByVal existingItemID As String, _
ByVal existingOperID As String, _
ByVal existingOperDesc As String, _
ByVal existingEntID As Integer, _
ByVal existingVerID As String, _
ByVal existingPreferredVer As Boolean, _
ByVal existingDesignHold As Boolean, _
ByVal existingUDF1 As String, _
ByVal existingUDF2 As String, _
ByVal existingNotes As String, _
ByRef newItemClassID As String, _
ByRef newItemClassDesc As String, _
ByRef newItemID As String, _
ByRef newItemDesc As String, _
ByRef newOperID As String, _
ByRef newOperDesc As String, _
ByRef newEntID As Integer, _
ByRef newEntName As String, _
ByRef newVerID As String, _
ByRef newPrefVer As Boolean _
) As Boolean
public static bool CloneFolder(
string existingItemID,
string existingOperID,
string existingOperDesc,
int existingEntID,
string existingVerID,
bool existingPreferredVer,
bool existingDesignHold,
string existingUDF1,
string existingUDF2,
string existingNotes,
out string newItemClassID,
out string newItemClassDesc,
out string newItemID,
out string newItemDesc,
out string newOperID,
out string newOperDesc,
out int newEntID,
out string newEntName,
out string newVerID,
out bool newPrefVer
)
Parameters
- existingItemID
- Optional. Holds the item ID of the folder to be cloned.
- existingOperID
- Optional. Holds the operation ID of the folder to be cloned.
- existingOperDesc
- Optional. Holds the operation description of the folder to be cloned.
- existingEntID
- Optional. Holds the entity ID of the folder to be cloned.
- existingVerID
- Optional. Holds the version ID of the folder to be cloned.
- existingPreferredVer
- Optional. Holds the preferred version flag state of the folder to be cloned.
- existingDesignHold
- Optional. Holds the design hold flag state of the folder to be cloned.
- existingUDF1
- Optional. Holds the user-defined field 1 of the folder to be cloned.
- existingUDF2
- Optional. User defined field 2 of the folder to be cloned.
- existingNotes
- Optional. Holds the notes of the folder to be cloned.
- newItemClassID
- Required. Holds the item class ID of the new folder or an empty string if a folder is not created.
- newItemClassDesc
- Required. Holds the item class description of the new folder or an empty string if a folder is not created.
- newItemID
- Required. Holds the item ID of the new folder or an empty string if a folder is not created.
- newItemDesc
- Required. Holds the item description of the new folder or an empty string if a folder is not created.
- newOperID
- Required. Holds the operation ID of the new folder or an empty string if a folder is not created.
- newOperDesc
- Required. Holds the operation description of the new folder or an empty string if a folder is not created.
- newEntID
- Required. Holds the entity ID of the new folder or -1 if a folder is not created.
- newEntName
- Required. Holds the entity name of the new folder or an empty string if a folder is not created.
- newVerID
- Required. Holds the version ID of the new folder or an empty string if a folder is not created.
- newPrefVer
- Required. Holds the preferred version flag of the new folder, or is set to false if a folder is not created.
Return Value
Returns true if the user successfully creates a folder, or false if the user
cancels creating the folder.