Files an instance of a
Containable subclass to this folder. Depending on the
IContainable subclass filed, a
IReferentialContainmentRelationship (RCR) object (for custom objects and folders)
or a
IDynamicReferentialContainmentRelationship (DRCR) object (for documents) is
created to reference this folder and the containee (instance filed).
A
IFileEvent is triggered by the creation of a RCR or DRCR object.
The source object of the event is the
IFolder object on which the
File method was invoked.
Namespace:
FileNet.Api.Core
Assembly:
FileNet.Api (in FileNet.Api.dll)
JavaScript |
---|
function file(containee, autoUniqueName, containmentName, defineSecurityParentage); |
Parameters
- containee
- Type: FileNet.Api.Core..::.IIndependentlyPersistableObject
An IndependentlyPersistableObject object for the Containable subclass instance to be filed.
- autoUniqueName
- Type: FileNet.Api.Constants..::.AutoUniqueName
An AutoUniqueName object indicating whether to detect and resolve naming collisions
of containment names.
If no value is provided for the containmentName parameter, the server will derive one as described in
ContainmentName,
and the server will default to the AUTO_UNIQUE value for this parameter.
- containmentName
- Type: System..::.String
A String containing the containment name to assign to the new object. By
default, this is the file name of the object. The following characters are not allowed:
\ / : * ? " < > |
- defineSecurityParentage
- Type: FileNet.Api.Constants..::.DefineSecurityParentage
A DefineSecurityParentage object indicating whether the containing folder is to be used as a security parent. If so, the
SecurityFolder property of the object being added is automatically set to this folder.
Return Value
A
ReferentialContainmentRelationship object where this folder is the tail and the object filed (containee) is the
head.