The setting that determines whether a document can be a parent component in a compound document. The CompoundDocumentState enumeration has constants defined for the compound document state settings.
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Valid settings are:
: Designates the document as the parent component in a compound document. Initially, this parent document has no child components. A document must be designated as a compound document to become a parent component for aCOMPOUND_DOCUMENT
object.ComponentRelationship
(default setting - 4.0.x release): Designates the document as a standard document. This setting prevents the document from being a parent component within a compound document. A document cannot be designated as a standard document when referenced as a parent component by aSTANDARD_DOCUMENT
object.ComponentRelationship
(default setting - 3.5.x upgraded to 4.0.x): Designates the document as a standard document. By default, pre-existing documents in an object store upgraded to 4.0.x return anull
value instead ofnull
. Note that, although aSTANDARD_DOCUMENT
value can be returned, you cannot set this property tonull
.null
Namespace: FileNet.Api.Core
Assembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Property CompoundDocumentState As Nullable(Of CompoundDocumentState) |
C# |
---|
Nullable<CompoundDocumentState> CompoundDocumentState { get; set; } |
C++ |
---|
property Nullable<CompoundDocumentState> CompoundDocumentState abstract { Nullable<CompoundDocumentState> get(); void set(Nullable<CompoundDocumentState> value); } |
J# |
---|
/** property */ public Nullable<CompoundDocumentState> get_CompoundDocumentState(); /** property */ public void set_CompoundDocumentState(Nullable<CompoundDocumentState> value); |
JScript |
---|
public function get CompoundDocumentState() : Nullable<CompoundDocumentState> public function set CompoundDocumentState(value : Nullable<CompoundDocumentState>); |
Remarks
Metadata
AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: true
Datatype: LONG
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: 0
PropertyMaximumInteger32: 1
PropertyMinimumInteger32: 0
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ