The Document object designated as the child in a component relationship.

This property applies when the ComponentRelationshipType property setting is STATIC_CR, DYNAMIC_CR, or DYNAMIC_LABEL_CR. For all other component relationship types the value of this property is null. For a URI component relationship type, you designate the child component by setting the URIValue property.

For a ComponentRelationship object whose relationship type is STATIC_CR, set the value of this property to the specific document version to bind to the parent component document.

For a ComponentRelationship object whose relationship type is DYNAMIC_CR, some version of the child document must be eligible-for-binding; otherwise, calling the Save method on the ComponentRelationship object throws an exception. For example, a major version of the document must exist when the version bind rule specifies only major versions can be bound. For information on the version bind rule, see the VersionBindType property. When you call the Save method, the ChildComponent property is automatically updated to reflect the actual document version bound.

For a ComponentRelationship object whose relationship type is DYNAMIC_LABEL_CR, no version of the child document need be eligible-for-binding. When you call the Save method, the value of the ChildComponent property is automatically updated to null or to the actual document version bound. This bound version is the most recent version of the child document satisfying the version bind rule that has a ComponentBindingLabel property value matching the LabelBindValue property value. For more information on document binding, see the ComponentRelationshipType property. Note that, when the ChildComponent property value has been updated to null, you can still determine the child document for this relationship by using the ChildVersionSeries property.

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

ToggleSyntax

Visual Basic (Declaration)
Property ChildComponent As IDocument
C#
IDocument ChildComponent { get; set; }
Visual C++
property IDocument^ ChildComponent {
	IDocument^ get ();
	void set (IDocument^ value);
}
JavaScript
function get_childComponent();
function set_childComponent(value);

ToggleRemarks

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: ParentRelationships
RequiredClass: Document
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ToggleSee Also