Document Class

An InformationContentElement that identifies the content of a document. The realized form of a document is called a DocumentCarrier (different class than Document). For example, a will is a legal document. The will published into a PDF file is an ElectronicDocumentCopy. The will printed onto paper is a PrintedDocumentCopy. In this example, the Document only identifies, names, and tracks the content of the will.

Extends

• InformationContentElement

Extended by

• Drawing
• SheetBorderTemplate
• SheetTemplate
• Sheet
• GenericDocument

Methods

Name	Description
constructor(props: ElementProps, iModel: IModelDb): Document Protected

Inherited methods

Name	Inherited from	Description
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected Inherited	InformationContentElement	Collect the Ids of this element's references at this level of the class hierarchy.
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Inherited	InformationContentElement	Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void Inherited	InformationContentElement	Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void Inherited	InformationContentElement	Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData Inherited	InformationContentElement	Get the class metadata for this element.
getDisplayLabel(): string Inherited	InformationContentElement	Get a display label for this Element.
getJsonProperty(nameSpace: string): any Inherited	InformationContentElement	Get a JSON property of this element, by namespace
getPredecessorIds(): Id64Set Inherited	InformationContentElement	Get the Ids of this element's references.
getReferenceIds(): EntityReferenceSet Inherited	InformationContentElement	Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] Inherited	InformationContentElement	Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any Inherited	InformationContentElement	Get a set of JSON user properties by namespace
insert(): string Inherited	InformationContentElement	Insert this Element into the iModel.
removeUserProperties(nameSpace: string): void Inherited	InformationContentElement	Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void Inherited	InformationContentElement
setUserProperties(nameSpace: string, value: any): void Inherited	InformationContentElement	Change a set of user JSON properties of this Element by namespace.
toJSON(): ElementProps Inherited	InformationContentElement	Obtain the JSON representation of this Entity.
update(): void Inherited	InformationContentElement	Update this Element in the iModel.
is(otherClass: ): boolean Static Inherited	InformationContentElement	return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited	InformationContentElement	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 Protected Static Inherited	InformationContentElement	Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static Inherited	InformationContentElement	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 Protected Static Inherited	InformationContentElement	Called after an existing element has been updated so that an instance of this class is its new parent.
onChildDelete(_arg: OnChildElementIdArg): void Protected Static Inherited	InformationContentElement	Called when an element with an instance of this class as its parent is about to be deleted.
onChildDeleted(_arg: OnChildElementIdArg): void Protected Static Inherited	InformationContentElement	Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static Inherited	InformationContentElement	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 Protected Static Inherited	InformationContentElement	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 Protected Static Inherited	InformationContentElement	Called when a new element with an instance of this class as its parent is about to be inserted.
onChildInserted(_arg: OnChildElementIdArg): void Protected Static Inherited	InformationContentElement	Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static Inherited	InformationContentElement	Called when an element with an instance of this class as its parent is about to be updated.
onChildUpdated(_arg: OnChildElementIdArg): void Protected Static Inherited	InformationContentElement	Called after an element with an instance of this the class as its parent was updated.
onCloned(_context: IModelElementCloneContext, _sourceProps: ElementProps, _targetProps: ElementProps): void Protected Static Inherited	InformationContentElement	Called during the iModel transformation process after an Element from the source iModel was cloned for the target iModel.
onDelete(arg: OnElementIdArg): void Protected Static Inherited	InformationContentElement	Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void Protected Static Inherited	InformationContentElement	Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void Protected Static Inherited	InformationContentElement	Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void Protected Static Inherited	InformationContentElement	Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static Inherited	InformationContentElement	Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void Protected Static Inherited	InformationContentElement	Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void Protected Static Inherited	InformationContentElement	Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void Protected Static Inherited	InformationContentElement	Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void Protected Static Inherited	InformationContentElement	Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void Protected Static Inherited	InformationContentElement	Called after an Element was updated.

Properties

Name	Type	Description
className Accessor Static ReadOnly	string	The name of the BIS class associated with this class.

Inherited properties

Name	Type	Inherited from	Description
classFullName Accessor Inherited ReadOnly	string	InformationContentElement	Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly	string	InformationContentElement	Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly	string	InformationContentElement	The name of the BIS class associated with this class.
code Inherited	Code	InformationContentElement	The Code for this element
federationGuid Inherited	string | undefined	InformationContentElement	A FederationGuid assigned to this element by some other federated database
id Inherited	string	InformationContentElement	The Id of this Entity.
iModel Inherited	IModelDb	InformationContentElement	The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited	"true"	InformationContentElement	An immutable property used to discriminate between Entity and EntityProps, used to inform the TypeScript compiler that these two types
jsonProperties Readonly Inherited	[key: string]: any	InformationContentElement	Optional json properties of this element.
model Readonly Inherited	string	InformationContentElement	The ModelId of the Model containing this element
parent Inherited	RelatedElement | undefined	InformationContentElement	The parent element, if present, of this element.
requiredReferenceKeys Static Readonly Inherited	ReadonlyArray	InformationContentElement	A required reference is an element that had to be inserted before this element could have been inserted.
schema Static Inherited		InformationContentElement	The Schema that defines this class.
schemaName Accessor Inherited ReadOnly	string	InformationContentElement	The name of the BIS Schema that defines this class
userLabel Inherited	string | undefined	InformationContentElement	A user-assigned label for this element.

Defined in

• core/backend/src/Element.ts Line 764