The name of the contained object.

For a DynamicReferentialContainmentRelationship or ReferentialContainmentRelationship object, this is the name of the Head object in the relationship. The default value is supplied as follows:

  • If the Head object has a MimeType property (in other words, the Head object is a Document), and if both the Name and MimeType properties of the Head object are present and not zero length, then the default value is Name.FileExtension. Content Engine maps the MIME type of the Head object to a file extension based on the mimetypes.properties file to determine FileExtension. If an apparent file extension is already present in the value of the Name property, then the default is the Name value of the Head object (no FileExtension is appended). If the value of the MimeType property does not map to any file extension, then no FileExtension is appended. In all cases, invalid characters (see list below) are removed from the Name value, and the Name value is truncated to 255 characters.
  • If the MimeType property value is not present, the default is the Name value of the Head object. Invalid characters are removed from the Name value, and the Name value is truncated to 255 characters.
  • If the Name value is not found, the Id value of the Head object is used.

The following characters are not allowed:

  • asterisk
  • forward slash
  • backslash
  • colon
  • question mark
  • double quote
  • less than
  • greater than
  • pipe

For an Event object generated from the IFileEvent and IUnfileEvent classes, the value of this property is the name of the Containable object that was added or removed, respectively .

In the following scenarios, the server looks for naming collisions and makes the containment name unique:

  • If AutoUniqueName.AUTO_UNIQUE is set when the document is filed. This setting should be used with caution, as described in AutoUniqueName Enumeration.
  • If an object that is filed in a folder is marked for deletion, the server modifies the containment name in any relationship objects referenced by the object marked for deletion. This is done to prevent a collision with any new object filed into the same folder, using the same containment name. If the object is later restored, the server attempts to change the containment names back to their original values (before the object was marked for deletion). For more information about marking objects for deletion, see Recovery Bin Concepts.

If a naming collision is detected when AutoUniqueName.AUTO_UNIQUE is set, or when an object that's marked for deletion object is restored, the server resolves the conflict by appending a uniquifier to the the containment name, as follows:

  • The server first iterates a set of serial integers to create a unique name with a parenthesized number, such as "myDocument(14)".
  • If a unique name is still not found, the server appends a tilde followed by five random characters to the containment name, such as "myDocument~Ae7Hq".

Namespace:  FileNet.Api.Core
Assembly:  FileNet.Api (in FileNet.Api.dll)

ToggleSyntax

Visual Basic (Declaration)
Property ContainmentName As String
C#
string ContainmentName { get; set; }
Visual C++
property String^ ContainmentName {
	String^ get ();
	void set (String^ value);
}
JavaScript
function get_containmentName();
function set_containmentName(value);

ToggleRemarks

ToggleSee Also