API Reference › core-backend› Elements › SheetIndexFolder

SheetIndexFolder Class @beta

A container used to group SheetIndexEntrys within a SheetIndex.

Extends

Methods

Name Description
constructor(props: SheetIndexEntryProps, iModel: IModelDb): SheetIndexFolder Protected    
create(arg: SheetIndexEntryCreateArgs): SheetIndexFolder Static Create a new SheetIndexFolder  
insert(arg: SheetIndexEntryCreateArgs): string Static Create a new SheetIndexFolder  

Inherited methods

Name Inherited from Description
collectPredecessorIds(predecessorIds: EntityReferenceSet): void Protected Inherited SheetIndexEntry Collect the Ids of this element's references at this level of the class hierarchy.
collectReferenceIds(referenceIds: EntityReferenceSet): void Protected Inherited SheetIndexEntry Collect the Ids of this entity's references at this level of the class hierarchy.
delete(): void Inherited SheetIndexEntry Delete this Element from the iModel.
forEachProperty(func: PropertyCallback, includeCustom: booleantrue): void Inherited SheetIndexEntry Call a function for each property of this Entity.
getClassMetaData(): undefined | EntityMetaData Inherited SheetIndexEntry Get the class metadata for this element.
getDisplayLabel(): string Inherited SheetIndexEntry Get a display label for this Element.
getJsonProperty(nameSpace: string): any Inherited SheetIndexEntry Get a JSON property of this element, by namespace
getPredecessorIds(): Id64Set Inherited SheetIndexEntry Get the Ids of this element's references.
getReferenceIds(): EntityReferenceSet Inherited SheetIndexEntry Get the set of this entity's entity references, EntityReferenceSet.
getToolTipMessage(): string[] Inherited SheetIndexEntry Get a list of HTML strings that describe this Element for the tooltip.
getUserProperties(namespace: string): any Inherited SheetIndexEntry Get a set of JSON user properties by namespace
insert(): string Inherited SheetIndexEntry Insert this Element into the iModel.
removeUserProperties(nameSpace: string): void Inherited SheetIndexEntry Remove a set of JSON user properties, specified by namespace, from this Element
setJsonProperty(nameSpace: string, value: any): void Inherited SheetIndexEntry  
setUserProperties(nameSpace: string, value: any): void Inherited SheetIndexEntry Change a set of user JSON properties of this Element by namespace.
toJSON(): SheetIndexEntryProps Inherited SheetIndexEntry Obtain the JSON representation of this Entity.
update(): void Inherited SheetIndexEntry Update this Element in the iModel.
createCode(iModelDb: IModelDb, scopeModelId: string, codeValue: string): Code Static Inherited SheetIndexEntry Create a Code for a Sheet Index Entry given a name that is meant to be unique within the scope of the specified SheetIndexModel.
createParentRelationshipProps(iModelDb: IModelDb, id: string): RelatedElementProps Protected Static Inherited SheetIndexEntry  
createProps(arg: SheetIndexEntryCreateArgs): SheetIndexEntryProps Protected Static Inherited SheetIndexEntry  
is(otherClass: ): boolean Static Inherited SheetIndexEntry return whether this Entity class is a subclass of another Entity class
onAllInputsHandled(_id: string, _iModel: IModelDb): void Protected Static Inherited SheetIndexEntry 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 SheetIndexEntry Called when a root element in a subgraph is changed and before its outputs are processed.
onChildAdd(_arg: OnChildElementPropsArg): void Protected Static Inherited SheetIndexEntry 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 SheetIndexEntry 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 SheetIndexEntry 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 SheetIndexEntry Called after an element with an instance of this class as its parent was successfully deleted.
onChildDrop(_arg: OnChildElementIdArg): void Protected Static Inherited SheetIndexEntry 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 SheetIndexEntry 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 SheetIndexEntry 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 SheetIndexEntry Called after a new element with an instance of this class as its parent was inserted.
onChildUpdate(_arg: OnChildElementPropsArg): void Protected Static Inherited SheetIndexEntry 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 SheetIndexEntry 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 SheetIndexEntry 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 SheetIndexEntry Called before an Element is deleted.
onDeleted(_arg: OnElementIdArg): void Protected Static Inherited SheetIndexEntry Called after an Element was deleted.
onInsert(arg: OnElementPropsArg): void Protected Static Inherited SheetIndexEntry Called before a new Element is inserted.
onInserted(arg: OnElementIdArg): void Protected Static Inherited SheetIndexEntry Called after a new Element was inserted.
onSubModelDelete(_arg: OnSubModelIdArg): void Protected Static Inherited SheetIndexEntry Called when a sub-model of an instance of this class is being deleted.
onSubModelDeleted(_arg: OnSubModelIdArg): void Protected Static Inherited SheetIndexEntry Called after a sub-model of an instance of this class was deleted.
onSubModelInsert(_arg: OnSubModelPropsArg): void Protected Static Inherited SheetIndexEntry Called when an instance of this class is being sub-modeled by a new Model.
onSubModelInserted(_arg: OnSubModelIdArg): void Protected Static Inherited SheetIndexEntry Called after an instance of this class was sub-modeled by a new Model.
onUpdate(arg: OnElementPropsArg): void Protected Static Inherited SheetIndexEntry Called before an Element is updated.
onUpdated(_arg: OnElementIdArg): void Protected Static Inherited SheetIndexEntry 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 SheetIndexEntry Get the full BIS class name of this Entity in the form "schema:class".
classFullName Accessor Static Inherited ReadOnly string SheetIndexEntry Get the full BIS class name of this Entity in the form "schema:class"
className Accessor Inherited ReadOnly string SheetIndexEntry The name of the BIS class associated with this class.
code Inherited Code SheetIndexEntry The Code for this element
entryPriority Inherited number SheetIndexEntry Can be used to prioritize or order members within a SheetIndex or SheetIndexFolder.
federationGuid Inherited string | undefined SheetIndexEntry A FederationGuid assigned to this element by some other federated database
id Inherited string SheetIndexEntry The Id of this Entity.
iModel Inherited IModelDb SheetIndexEntry The IModelDb that contains this Entity
isInstanceOfEntity Readonly Inherited "true" SheetIndexEntry 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 SheetIndexEntry Optional json properties of this element.
model Readonly Inherited string SheetIndexEntry The ModelId of the Model containing this element
parent Inherited RelatedElement | undefined SheetIndexEntry The parent element, if present, of this element.
requiredReferenceKeys Static Readonly Inherited ReadonlyArray SheetIndexEntry A required reference is an element that had to be inserted before this element could have been inserted.
schema Static Inherited SheetIndexEntry The Schema that defines this class.
schemaName Accessor Inherited ReadOnly string SheetIndexEntry The name of the BIS Schema that defines this class
userLabel Inherited string | undefined SheetIndexEntry A user-assigned label for this element.

Defined in

Last Updated: 24 June, 2025