API Reference > imodeljs-backend > Elements > DocumentPartition DocumentPartition Class A DocumentPartition element establishes a Document modeling perspective for its parent Subject. A DocumentPartition is always sub-modeled by a DocumentListModel. see DocumentListModel Extends InformationPartitionElement Inherited methods Name Inherited from Description buildConcurrencyControlRequest(opcode: DbOpcode): void InformationPartitionElement Add a request for locks, code reservations, and anything else that would be needed to carry out the specified operation. collectPredecessorIds(predecessorIds: Id64Set): void Protected InformationPartitionElement Collect the Ids of this element's predecessors at this level of the class hierarchy. delete(): void InformationPartitionElement Delete this Element from the iModel. forEachProperty(func: PropertyCallback, includeCustom: boolean = true): void InformationPartitionElement Call a function for each property of this Entity. getClassMetaData(): undefined | EntityMetaData InformationPartitionElement Get the class metadata for this element. getDisplayLabel(): string InformationPartitionElement Get a display label for this Element. getJsonProperty(nameSpace: string): any InformationPartitionElement Get a JSON property of this element, by namespace getPredecessorIds(): Id64Set InformationPartitionElement Get the Ids of this element's predecessors. getToolTipMessage(): string[] InformationPartitionElement Get a list of HTML strings that describe this Element for the tooltip. getUserProperties(namespace: string): any InformationPartitionElement Get a set of JSON user properties by namespace insert(): string InformationPartitionElement Insert this Element into the iModel. removeUserProperties(nameSpace: string): void InformationPartitionElement Remove a set of JSON user properties, specified by namespace, from this Element setJsonProperty(nameSpace: string, value: any): void InformationPartitionElement setUserProperties(nameSpace: string, value: any): void InformationPartitionElement Change a set of user JSON properties of this Element by namespace. update(): void InformationPartitionElement Update this Element in the iModel. createCode(iModel: IModelDb, parentSubjectId: string, codeValue: string): Code Static InformationPartitionElement Create a code that can be used for any subclass of InformationPartitionElement. is(otherClass: undefined): boolean Static InformationPartitionElement return whether this Entity class is a subclass of another Entity class onAllInputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic InformationPartitionElement Called on an element in a graph after all of its inputs have been processed and before its outputs are processed. onBeforeOutputsHandled(_id: string, _iModel: IModelDb): void ProtectedStatic InformationPartitionElement Called when a root element in a subgraph is changed and before its outputs are processed. onChildAdd(_arg: OnChildElementPropsArg): void ProtectedStatic InformationPartitionElement Called when an existing element is about to be updated so that an instance of this class will become its new parent. onChildAdded(_arg: OnChildElementIdArg): void ProtectedStatic InformationPartitionElement Called after an existing element has been updated so that an instance of this class is its new parent. onChildDelete(_arg: OnChildElementIdArg): void ProtectedStatic InformationPartitionElement Called when an element with an instance of this class as its parent is about to be deleted. onChildDeleted(_arg: OnChildElementIdArg): void ProtectedStatic InformationPartitionElement Called after an element with an instance of this class as its parent was successfully deleted. onChildDrop(_arg: OnChildElementIdArg): void ProtectedStatic InformationPartitionElement Called when an element with an instance of this class as its parent is about to be updated change to a different parent. onChildDropped(_arg: OnChildElementIdArg): void ProtectedStatic InformationPartitionElement Called after an element with an instance of this class as its previous parent was updated to have a new parent. onChildInsert(_arg: OnChildElementPropsArg): void ProtectedStatic InformationPartitionElement Called when a new element with an instance of this class as its parent is about to be inserted. onChildInserted(_arg: OnChildElementIdArg): void ProtectedStatic InformationPartitionElement Called after a new element with an instance of this class as its parent was inserted. onChildUpdate(_arg: OnChildElementPropsArg): void ProtectedStatic InformationPartitionElement Called when an element with an instance of this class as its parent is about to be updated. onChildUpdated(_arg: OnChildElementIdArg): void ProtectedStatic InformationPartitionElement Called after an element with an instance of this the class as its parent was updated. onCloned(_context: IModelCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void ProtectedStatic InformationPartitionElement Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel. onDelete(arg: OnElementIdArg): void ProtectedStatic InformationPartitionElement Called before an Element is deleted. onDeleted(_arg: OnElementIdArg): void ProtectedStatic InformationPartitionElement Called after an Element was deleted. onInsert(arg: OnElementPropsArg): void ProtectedStatic InformationPartitionElement Called before a new Element is inserted. onInserted(arg: OnElementIdArg): void ProtectedStatic InformationPartitionElement Called after a new Element was inserted. onSubModelDelete(_arg: OnSubModelIdArg): void ProtectedStatic InformationPartitionElement Called when a sub-model of an instance of this class is being deleted. onSubModelDeleted(_arg: OnSubModelIdArg): void ProtectedStatic InformationPartitionElement Called after a sub-model of an instance of this class was deleted. onSubModelInsert(_arg: OnSubModelPropsArg): void ProtectedStatic InformationPartitionElement Called when an instance of this class is being sub-modeled by a new Model. onSubModelInserted(_arg: OnSubModelIdArg): void ProtectedStatic InformationPartitionElement Called after an instance of this class was sub-modeled by a new Model. onUpdate(arg: OnElementPropsArg): void ProtectedStatic InformationPartitionElement Called before an Element is updated. onUpdated(arg: OnElementIdArg): void ProtectedStatic InformationPartitionElement Called after an Element was updated. populateRequest(req: ConcurrencyControl.Request, props: ElementProps, iModel: IModelDb, opcode: DbOpcode, original: undefined | ElementProps): void Static InformationPartitionElement Disclose the codes and locks needed to perform the specified operation on this element Inherited properties Name Type Inherited from Description classFullName Accessor ReadOnly string InformationPartitionElement Get the full BIS class name of this Entity in the form "schema:class". classFullName Accessor StaticReadOnly string InformationPartitionElement Get the full BIS class name of this Entity in the form "schema:class" className Accessor ReadOnly string InformationPartitionElement The name of the BIS class associated with this class. code Code InformationPartitionElement The Code for this element description undefined | string InformationPartitionElement A human-readable string describing the intent of the partition. federationGuid undefined | string InformationPartitionElement A FederationGuid assigned to this element by some other federated database id string InformationPartitionElement The Id of this Entity. iModel IModelDb InformationPartitionElement The IModelDb that contains this Entity jsonProperties Readonly { T } InformationPartitionElement Optional json properties of this element. model Readonly string InformationPartitionElement The ModelId of the Model containing this element parent undefined | RelatedElement InformationPartitionElement The parent element, if present, of this element. schema Static undefined InformationPartitionElement The Schema that defines this class. schemaName Accessor ReadOnly string InformationPartitionElement The name of the BIS Schema that defines this class userLabel undefined | string InformationPartitionElement A user-assigned label for this element. Defined in core/backend/src/Element.ts Line 1381 Last Updated: 11 June, 2024