 | ConnectionCreateNewDocument Method |
Creates a new document in the vault and optionally sets its properties.
Namespace:
ICMeridianAPI
Assembly:
ICMeridianAPI (in ICMeridianAPI.dll) Version: 4.0.9.0 (4.0.9.0)
Syntaxpublic string CreateNewDocument(
string vaultidentifier,
string documentpath,
string filename,
string doctypename = "",
string sourcefilefullpath = "",
Object properties = null,
Object values = null
)
Public Function CreateNewDocument (
vaultidentifier As String,
documentpath As String,
filename As String,
Optional doctypename As String = "",
Optional sourcefilefullpath As String = "",
Optional properties As Object = Nothing,
Optional values As Object = Nothing
) As String
Parameters
- vaultidentifier
- Type: SystemString
The vault in which the new document should be created. - documentpath
- Type: SystemString
The path location in which the new document should be created. The path should not
include a filename. - filename
- Type: SystemString
The name of the new document. - doctypename (Optional)
- Type: SystemString
The document type name to be used for the new document.
The vault’s default document type is used if no document type is specified or the user interface will be activated if no decision can be made. - sourcefilefullpath (Optional)
- Type: SystemString
A local source file that provides the content of the new document. If no source file is
specified, the document is either left empty or the user is asked to select a template if document
templates are defined. - properties (Optional)
- Type: SystemObject
An array of property names for the new document that need to be initialized with values. - values (Optional)
- Type: SystemObject
An array of values for the properties specified in the properties parameter.
The dimensions of the properties array and values array should be identical.
The values array must be an array of variants.
Return Value
Type:
StringID of the newly created document
RemarksThe new document is in the Under Change state after creation.
See Also